net.sf.saxon.tree.iter

Interface Summary
Interface	Description
AtomicIterator	A SequenceIterator is used to iterate over a sequence.
AxisIterator	A SequenceIterator is used to iterate over a sequence of items.
GroundedIterator	This interface is an extension to the SequenceIterator interface; it represents a SequenceIterator that is based on an in-memory representation of a sequence, and that is therefore capable of returning a SequenceValue containing all the items in the sequence.
LookaheadIterator	A SequenceIterator is used to iterate over a sequence.
NodeWrappingFunction<B,T extends NodeInfo>	Interface to a function that wraps nodes from an external object model in a Saxon NodeInfo representation
ReversibleIterator	A ReversibleIterator is an interface implemented by any SequenceIterator that is able to deliver items in reverse order (or to supply another iterator that can do so).
UnfailingIterator	A SequenceIterator is used to iterate over a sequence.

Class Summary
Class	Description
AdjacentTextNodeMergingIterator	AdjacentTextNodeMergingIterator is an iterator that eliminates zero-length text nodes and merges adjacent text nodes from the underlying iterator
ArrayIterator	ArrayIterator is used to enumerate items held in an array.
AtomizingIterator	AtomizingIterator returns the atomization of an underlying sequence supplied as an iterator.
AxisIteratorImpl	A SequenceIterator is used to iterate over a sequence.
AxisIteratorOverSequence	This class wraps any SequenceIterator as an AxisIterator.
EmptyIterator	EmptyIterator: an iterator over an empty sequence.
EmptyIterator.OfAtomic	An empty iterator for use where a sequence of atomic values is required
EmptyIterator.OfNodes	An empty iterator for use where a sequence of nodes is required
HomogeneityCheckerIterator	An iterator that returns the same items as its base iterator, checking to see that they are either all nodes, or all non-nodes; if they are all nodes, it delivers them in document order.
IteratorIterator<T extends Item>	A SequenceIterator that wraps a Java Iterator.
ListIterator	Class ListIterator, iterates over a sequence of items held in a Java List
ListIterator.Atomic
LookaheadIteratorImpl	This class wraps any sequence iterator, turning it into a lookahead iterator, by looking ahead one item
ManualIterator	ManualIterator: a pseudo-iterator used while streaming.
NodeWrappingAxisIterator<B>	An AxisIterator that wraps a Java Iterator.
PrependIterator	An iterator over nodes, that prepends a given node to the nodes returned by another iterator.
ReverseListIterator	ReverseListIterator is used to enumerate items held in an array in reverse order.
SingleAtomicIterator	SingletonIterator: an iterator over a sequence of zero or one values
SingleNodeIterator	SingleNodeIterator: an iterator over a sequence of zero or one nodes
SingletonIterator	SingletonIterator: an iterator over a sequence of zero or one values
TextLinesIterator	An iterator that iterates over a file line by line.
UnparsedTextIterator	Class UnparsedTextIterator, iterates over a file line by line
UntypedAtomizingIterator	AtomizingIterator returns the atomization of an underlying sequence supplied as an iterator.

Package net.sf.saxon.tree.iter Description

This package defines implementations and subinterfaces of the interface SequenceIterator, which is used to iterate over an XDM sequence.

The subinterfaces mostly represent iterators with additional capability: for example a LastPositionFinder can determine the number of items in the sequence without reading to the end; a GroundedIterator can deliver the original sequence as a list in memory; a LookaheadIterator is capable of one-item look-ahead. Note that just because a class implements such an interface does not mean it necessarily has this capability; it is necessary to check the properties of the specific iterator before assuming this.

Michael H. Kay
Saxonica Limited
28 November 2011