net.sf.saxon.tree.util

Class SteppingNavigator.DescendantAxisIterator<N extends SteppingNode<N>>

java.lang.Object

net.sf.saxon.tree.util.SteppingNavigator.DescendantAxisIterator<N>

All Implemented Interfaces:

Closeable, AutoCloseable, SequenceIterator<NodeInfo>, AxisIterator, UnfailingIterator<NodeInfo>

Enclosing class:

SteppingNavigator

public static class SteppingNavigator.DescendantAxisIterator<N extends SteppingNode<N>>
extends Object
implements AxisIterator

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

Field Summary

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

ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close() Close the iterator.
int	getProperties() Get properties of this iterator, as a bit-significant integer.
N	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.tree.iter.UnfailingIterator

firstWith, forEach, toGroundedValue, toList

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

forEachOrFail, materialize

Constructor Detail

DescendantAxisIterator

public DescendantAxisIterator(N 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 Detail

next

public N next()

Description copied from interface: UnfailingIterator

Get the next item in the sequence.

Specified by:

next in interface SequenceIterator<NodeInfo>

Specified by:

next in interface AxisIterator

Specified by:

next in interface UnfailingIterator<NodeInfo>

Returns:

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

close

public void close()

Description copied from interface: SequenceIterator

Close the iterator. This indicates to the supplier of the data that the client does not require any more items to be delivered by the iterator. This may enable the supplier to release resources. After calling close(), no further calls on the iterator should be made; if further calls are made, the effect of such calls is undefined.

For example, the iterator returned by the unparsed-text-lines() function has a close() method that causes the underlying input stream to be closed, whether or not the file has been read to completion.

Closing an iterator is important when the data is being "pushed" in another thread. Closing the iterator terminates that thread and means that it needs to do no additional work. Indeed, failing to close the iterator may cause the push thread to hang waiting for the buffer to be emptied.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SequenceIterator<NodeInfo>

getProperties

public int getProperties()

Description copied from interface: SequenceIterator

Get properties of this iterator, as a bit-significant integer.

Specified by:

getProperties in interface SequenceIterator<NodeInfo>

Returns:

the properties of this iterator. This will be some combination of properties such as SequenceIterator.GROUNDED, SequenceIterator.LAST_POSITION_FINDER, and SequenceIterator.LOOKAHEAD. It is always acceptable to return the value zero, indicating that there are no known special properties. It is acceptable for the properties of the iterator to change depending on its state.