org.jbind.xml.instance.use
Class EmptyUseStateIterator

java.lang.Object
  org.jbind.xml.instance.use.EmptyUseStateIterator

All Implemented Interfaces:

IUseStateIterator

public class EmptyUseStateIterator

extends java.lang.Object

implements IUseStateIterator

Field Summary

static IUseStateIterator

INSTANCE

Method Summary

IElemDesc	getNextElemDesc(java.lang.String aNamespace, java.lang.String aName, IAnyType anOverloadingType, IHasLocation aHasLocation) Gets a description for the next element.
IElemRefOrDecl	getSubstitutionHead() Gets the substitution head for the last element description returned.
void	isValidEnd(IHasLocation aHasLocation) Checks if the use iterator is in a valid end state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final IUseStateIterator INSTANCE

Method Detail

getNextElemDesc

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

Description copied from interface: IUseStateIterator

Gets a description for the next element. If no description is returned then the element and all its nested elements are skipped, i.e. no data objects are created for them.

Specified by:

getNextElemDesc in interface IUseStateIterator

Parameters:

aNamespace - (required). The namespace of the element.

aName - (required). The name of the element.

anOverloadingType - (optional). Used by wildcard element if the element declaration can not be found.

aHasLocation - (optional).

Returns:

(optional).

Throws:

XmlException - Raised iff no element description could be found but the element must not be skipped.

isValidEnd

public void isValidEnd(IHasLocation aHasLocation)

Description copied from interface: IUseStateIterator

Checks if the use iterator is in a valid end state.

Specified by:

isValidEnd in interface IUseStateIterator

Parameters:

aHasLocation - (optional).

getSubstitutionHead

public IElemRefOrDecl getSubstitutionHead()

Description copied from interface: IUseStateIterator

Gets the substitution head for the last element description returned. If the last element description returned was a substitute for another element description then the substituted element description is returned.

Specified by:

getSubstitutionHead in interface IUseStateIterator

Returns:

(optional).