net.sf.saxon.tree.util

Class Navigator.DescendantEnumeration

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing class:

Navigator

public static final class Navigator.DescendantEnumeration
extends java.lang.Object
implements AxisIterator

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.

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

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

close, discharge

Constructor Detail

DescendantEnumeration

public 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: SequenceIterator

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

Specified by:

next in interface SequenceIterator

Specified by:

next in interface AxisIterator

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.

advance

public void advance()