net.sf.saxon.tree.util

Class Navigator.DescendantEnumeration

java.lang.Object

net.sf.saxon.tree.iter.AxisIteratorImpl

net.sf.saxon.tree.util.Navigator.DescendantEnumeration

All Implemented Interfaces:

SequenceIterator, AxisIterator, UnfailingIterator

Enclosing class:

Navigator

public static final class Navigator.DescendantEnumeration
extends AxisIteratorImpl

General-purpose implementation of the descendant and descendant-or-self axes, in terms of the child axis. But it also has the option to return the descendants in reverse document order; this is used when evaluating the preceding axis. Note that the includeSelf option should not be used when scanning in reverse order, as the self node will always be returned first.

Field Summary

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

ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

Constructors

Constructor and Description
Navigator.DescendantEnumeration(NodeInfo start, boolean includeSelf, boolean forwards) Create an iterator over the descendant or descendant-or-self axis

Method Summary

Methods

Modifier and Type	Method and Description
void	advance()
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 class net.sf.saxon.tree.iter.AxisIteratorImpl

close, getProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

Navigator.DescendantEnumeration

public Navigator.DescendantEnumeration(NodeInfo start,
                               boolean includeSelf,
                               boolean forwards)

Create an iterator over the descendant or descendant-or-self axis

Parameters:

start - the initial context node

includeSelf - true if the "self" node is to be included

forwards - true for a forwards iteration, false for reverse order

Method Detail

next

public final NodeInfo next()

Description copied from interface: UnfailingIterator

Get the next item in the sequence.

Returns:

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

advance

public void advance()

getAnother

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

Returns:

a new iterator over the same sequence