net.sf.saxon.tree.tiny

Class SiblingIterator

java.lang.Object

net.sf.saxon.tree.tiny.SiblingIterator

All Implemented Interfaces:

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

final class SiblingIterator
extends Object
implements AxisIterator, LookaheadIterator<NodeInfo>, AtomizedValueIterator<NodeInfo>

This class supports both the child:: and following-sibling:: axes, which are identical except for the route to the first candidate node. It enumerates either the children or the following siblings of the specified node. In the case of children, the specified node must always be a node that has children: to ensure this, construct the iterator using NodeInfo#iterateAxis()

Field Summary

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

ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

Constructors

Constructor and Description
SiblingIterator(TinyTree tree, TinyNodeImpl node, NodeTest nodeTest, boolean getChildren) Return an enumeration over children or siblings of the context node

Method Summary

Modifier and Type	Method and Description
int	getProperties() Get properties of this iterator, as a bit-significant integer.
boolean	hasNext() Test whether there are any more nodes to come.
NodeInfo	next() Return the next node in the sequence
AtomicSequence	nextAtomizedValue() Deliver the atomic value that is next in the atomized result

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

close, forEachOrFail, materialize

Constructor Detail

SiblingIterator

SiblingIterator(TinyTree tree,
                TinyNodeImpl node,
                NodeTest nodeTest,
                boolean getChildren)

Return an enumeration over children or siblings of the context node

Parameters:

tree - The TinyTree containing the context node

node - The context node, the start point for the iteration

nodeTest - Test that the selected nodes must satisfy, or null indicating that all nodes are selected

getChildren - True if children of the context node are to be returned, false if following siblings are required

Method Detail

next

public NodeInfo next()

Return the next node 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 node, or null if the end of the sequence is reached

nextAtomizedValue

public AtomicSequence nextAtomizedValue()
                                 throws XPathException

Deliver the atomic value that is next in the atomized result

Specified by:

nextAtomizedValue in interface AtomizedValueIterator<NodeInfo>

Returns:

the next atomic value

Throws:

XPathException - if a failure occurs reading or atomizing the next value

hasNext

public boolean hasNext()

Test whether there are any more nodes to come. This method is used only when testing whether the current item is the last in the sequence. It's not especially efficient, but is more efficient than the alternative strategy which involves counting how many nodes there are in the sequence.

Specified by:

hasNext in interface LookaheadIterator<NodeInfo>

Returns:

true if there are more items in the sequence

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.