net.sf.saxon.tree.iter

Interface AxisIterator

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, SequenceIterator

All Known Implementing Classes:

AncestorIterator, ArrayIterator.OfNodes, AxiomDocument.FollowingSiblingIterator, AxiomDocument.PrecedingSiblingIterator, AxiomDocumentNodeWrapper.FollowingSiblingIterator, AxiomDocumentNodeWrapper.PrecedingSiblingIterator, AxiomParentNodeWrapper.ChildWrappingIterator, AxiomParentNodeWrapper.DescendantWrappingIterator, ConcatenatingAxisIterator, Navigator.AncestorEnumeration, Navigator.AxisFilter, Navigator.DescendantEnumeration, Navigator.EmptyTextFilter, Navigator.FollowingEnumeration, Navigator.PrecedingEnumeration, NodeListIterator, NodeWrappingAxisIterator, PrependAxisIterator, SingleNodeIterator, SteppingNavigator.DescendantAxisIterator, VirtualCopy.VirtualCopier, WrappingIterator

public interface AxisIterator
extends SequenceIterator

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.)

Method Summary

Modifier and Type	Method and Description
NodeInfo	next() Get the next item in the sequence.

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

close, discharge

Method Detail

next

NodeInfo next()

Description copied from interface: SequenceIterator

Get the next item in the sequence. This method changes the state of the iterator.

Specified by:

next in interface SequenceIterator

Returns:

the next item, or null if there are no more items. Once a call on next() has returned null, no further calls should be made. The preferred action for an iterator if subsequent calls on next() are made is to return null again, and all implementations within Saxon follow this rule.