Package net.sf.saxon.tree.util

Class SteppingNavigator.DescendantAxisIterator

java.lang.Object

net.sf.saxon.tree.util.SteppingNavigator.DescendantAxisIterator

All Implemented Interfaces:

Closeable, AutoCloseable, SequenceIterator, AxisIterator

Enclosing class:

SteppingNavigator

public static class SteppingNavigator.DescendantAxisIterator
extends Object
implements AxisIterator

An iterator over the descendant or descendant-or-self axis

Constructor Summary

Constructors

Constructor	Description
DescendantAxisIterator(SteppingNode start, boolean includeSelf, NodeTest test)	Create an iterator over the descendant or descendant-or-self axis

Method Summary

Modifier and Type	Method	Description
SteppingNode	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

Constructor Details

DescendantAxisIterator

public DescendantAxisIterator(SteppingNode start,
 boolean includeSelf,
 NodeTest test)

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

Parameters:

start - the root of the subtree whose descendants are required

includeSelf - true if this is the descendant-or-self axis

test - the node-test that selected nodes must satisfy

Method Details

next

public SteppingNode 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 AxisIterator

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.