org.jbind.xml.core.content
Interface IUseState

All Known Subinterfaces:

IElemRefOrDeclUseState, IElemUseState, IGroupUseState, IWildcardUseState

All Known Implementing Classes:

ContentUseState, ElemRefOrDeclUseState, ElemUseState, GroupUseState, GroupUseStateProxy, WildcardUseState

public interface IUseState

Method Summary

IContentDesc	getContentDesc() Gets the content of the use node.
IElemUseState	getNextUseState(java.lang.String aNamespace, java.lang.String aName, IAnyType anOverloadingType, IHasLocation aHasLocation) Gets the next use state that has a content use for the specified element.
IUseState	getParent() Gets the parent.
int	getUseCounter() Gets the use counter.
void	isValidEnd(IHasLocation aHasLocation)
void	reset() Resets the the use state.

Method Detail

getNextUseState

public IElemUseState getNextUseState(java.lang.String aNamespace,
                                     java.lang.String aName,
                                     IAnyType anOverloadingType,
                                     IHasLocation aHasLocation)
                              throws XmlException

Gets the next use state that has a content use for the specified element.

Parameters:

aNamespace - (required).

aName - (required).

Returns:

(optional).

Throws:

XmlException - Raised if this use state needs to return the next use state (e.g. because it is a sequence that has been started) but the specified element does not match.

getParent

public IUseState getParent()

Gets the parent.

Returns:

(optional).

getUseCounter

public int getUseCounter()

Gets the use counter. The use counter counts the number of method invokations of the getNextUseState method that returned a non-null result. In other words it counts the number of times an element was processed with this use state.

Returns:

The number of times the use state returned a non-null next use state.

reset

public void reset()

Resets the the use state. The use counter is set to 0 and any additional internal usage state is also reset.

getContentDesc

public IContentDesc getContentDesc()

Gets the content of the use node.

Returns:

(required).

isValidEnd

public void isValidEnd(IHasLocation aHasLocation)
                throws XmlException

Throws:

XmlException