Package net.sf.saxon.om
Class Navigator.BaseEnumeration
java.lang.Object
net.sf.saxon.om.AxisIteratorImpl
net.sf.saxon.om.Navigator.BaseEnumeration
- All Implemented Interfaces:
AtomizableIterator
,AxisIterator
,SequenceIterator
- Direct Known Subclasses:
Navigator.AncestorEnumeration
,Navigator.DescendantEnumeration
,Navigator.FollowingEnumeration
,Navigator.PrecedingEnumeration
- Enclosing class:
Navigator
BaseEnumeration is an abstract implementation of an AxisIterator, it
simplifies the implementation of the underlying AxisIterator by requiring
it to provide only two methods: advance(), and getAnother().
NOTA BENE: BaseEnumeration does not maintain the value of the position variable.
It must therefore either (a) be wrapped in an AxisFilter, which does maintain
position, or (b) be subclassed by a class that maintains position itself.
-
Field Summary
Fields inherited from class net.sf.saxon.om.AxisIteratorImpl
current, position
Fields inherited from interface net.sf.saxon.om.SequenceIterator
ATOMIZABLE, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract void
advance()
The advance() method must be provided in each concrete implementation.abstract SequenceIterator
Get another iterator over the same sequence of items, positioned at the start of the sequence.final Item
next()
Get the next item in the sequence.Methods inherited from class net.sf.saxon.om.AxisIteratorImpl
current, getProperties, isAtomizing, position, setIsAtomizing
-
Constructor Details
-
BaseEnumeration
public BaseEnumeration()
-
-
Method Details
-
next
Description copied from interface:AxisIterator
Get the next item in the sequence.- Returns:
- the next Item. If there are no more nodes, return null.
-
advance
public abstract void advance()The advance() method must be provided in each concrete implementation. It must leave the variable current set to the next node to be returned in the iteration, or to null if there are no more nodes to be returned. -
getAnother
Description copied from interface:AxisIterator
Get another iterator over the same sequence of items, positioned at the start of the sequence. It must be possible to call this method at any time, whether none, some, or all of the items in the original iterator have been read. The method is non-destructive: it does not change the state of the original iterator.- Returns:
- a new iterator over the same sequence
-