net.sf.saxon.tree.tiny

Class DescendantEnumeration

java.lang.Object

net.sf.saxon.tree.iter.AxisIteratorImpl

net.sf.saxon.tree.tiny.DescendantEnumeration

All Implemented Interfaces:

SequenceIterator, AxisIterator, UnfailingIterator

final class DescendantEnumeration
extends AxisIteratorImpl

This class supports both the descendant:: and descendant-or-self:: axes, which are identical except for the route to the first candidate node. It enumerates descendants of the specified node. The calling code must ensure that the start node is not an attribute or namespace node.

Field Summary

Fields inherited from class net.sf.saxon.tree.iter.AxisIteratorImpl

current, position

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

GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

Constructors

Constructor and Description
DescendantEnumeration(TinyTree doc, TinyNodeImpl node, NodeTest nodeTest, boolean includeSelf) Create an iterator over the descendant axis

Method Summary

Methods

Modifier and Type	Method and Description
SequenceIterator	getAnother() Get another enumeration of the same nodes
Item	next() Get the next item in the sequence.

Methods inherited from class net.sf.saxon.tree.iter.AxisIteratorImpl

atomize, close, current, getProperties, getStringValue, iterateAxis, moveNext, position

Methods inherited from class java.lang.Object

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

Constructor Detail

DescendantEnumeration

DescendantEnumeration(TinyTree doc,
                     TinyNodeImpl node,
                     NodeTest nodeTest,
                     boolean includeSelf)

Create an iterator over the descendant axis

Parameters:

doc - the containing TinyTree

node - the node whose descendants are required

nodeTest - test to be satisfied by each returned node

includeSelf - true if the start node is to be included

Method Detail

next

public Item next()

Description copied from interface: SequenceIterator

Get the next item in the sequence. This method changes the state of the iterator, in particular it affects the result of subsequent calls of position() and current().

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.

getAnother

public SequenceIterator getAnother()

Get another enumeration of the same nodes

Returns:

a SequenceIterator that iterates over the same items, positioned before the first item