net.sf.saxon.tree.iter

Interface AxisIterator

All Superinterfaces:

SequenceIterator, UnfailingIterator

All Known Implementing Classes:

AxiomDocumentWrapper.FollowingSiblingIterator, AxiomDocumentWrapper.PrecedingSiblingIterator, AxiomParentNodeWrapper.ChildWrappingIterator, AxiomParentNodeWrapper.DescendantWrappingIterator, AxisIteratorImpl, AxisIteratorOverSequence, EmptyIterator.OfNodes, Navigator.AncestorEnumeration, Navigator.AxisFilter, Navigator.DescendantEnumeration, Navigator.EmptyTextFilter, Navigator.FollowingEnumeration, Navigator.PrecedingEnumeration, NodeWrappingAxisIterator, PrependIterator, SingleNodeIterator, SteppingNavigator.DescendantAxisIterator, VirtualCopy.VirtualCopier, VirtualUntypedCopy.VirtualUntypedCopier, WrappingIterator

public interface AxisIterator
extends UnfailingIterator

A SequenceIterator is used to iterate over a sequence of items. An AxisIterator is a SequenceIterator that throws no exceptions, and that always returns nodes. The nodes should all be in the same document (though there are some cases, such as PrependIterator, where this is the responsibility of the user of the class and is not enforced.)

Field Summary

Fields inherited from interface net.sf.saxon.om.SequenceIterator

ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Method Summary

Methods

Modifier and Type	Method and Description
AxisIterator	getAnother() Get another iterator over the same sequence of items, positioned at the start of the sequence.
NodeInfo	next() Get the next item in the sequence.

Methods inherited from interface net.sf.saxon.om.SequenceIterator

close, getProperties

Method Detail

next

NodeInfo next()

Description copied from interface: UnfailingIterator

Get the next item in the sequence.

Specified by:

next in interface SequenceIterator

Specified by:

next in interface UnfailingIterator

Returns:

the next Item. If there are no more nodes, return null.

getAnother

AxisIterator getAnother()

Description copied from interface: UnfailingIterator

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.

Specified by:

getAnother in interface SequenceIterator

Specified by:

getAnother in interface UnfailingIterator

Returns:

a new iterator over the same sequence