Package net.sf.saxon.tree.tiny
Class SiblingIterator
java.lang.Object
net.sf.saxon.tree.tiny.SiblingIterator
- All Implemented Interfaces:
Closeable
,AutoCloseable
,AtomizedValueIterator
,SequenceIterator
,AxisIterator
,LookaheadIterator
,UnfailingIterator
final class SiblingIterator
extends Object
implements AxisIterator, LookaheadIterator, AtomizedValueIterator
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()
-
Nested Class Summary
Nested classes/interfaces inherited from interface net.sf.saxon.om.SequenceIterator
SequenceIterator.Property
-
Constructor Summary
ConstructorsConstructorDescriptionSiblingIterator
(TinyTree tree, TinyNodeImpl node, Predicate<? super NodeInfo> nodeTest, boolean getChildren) Return an enumeration over children or siblings of the context node -
Method Summary
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.AxisIterator
asIterator, forEachNode
Methods inherited from interface net.sf.saxon.om.SequenceIterator
close, forEachOrFail, materialize
Methods inherited from interface net.sf.saxon.tree.iter.UnfailingIterator
forEach, toList
-
Constructor Details
-
SiblingIterator
SiblingIterator(TinyTree tree, TinyNodeImpl node, Predicate<? super NodeInfo> nodeTest, boolean getChildren) Return an enumeration over children or siblings of the context node- Parameters:
tree
- The TinyTree containing the context nodenode
- The context node, the start point for the iterationnodeTest
- Test that the selected nodes must satisfy, or null indicating that all nodes are selectedgetChildren
- True if children of the context node are to be returned, false if following siblings are required
-
-
Method Details
-
next
Return the next node in the sequence- Specified by:
next
in interfaceAxisIterator
- Specified by:
next
in interfaceSequenceIterator
- Specified by:
next
in interfaceUnfailingIterator
- Returns:
- the next node, or null if the end of the sequence is reached
-
nextAtomizedValue
Deliver the atomic value that is next in the atomized result- Specified by:
nextAtomizedValue
in interfaceAtomizedValueIterator
- 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 interfaceLookaheadIterator
- Returns:
- true if there are more items in the sequence
-
getProperties
Description copied from interface:SequenceIterator
Get properties of this iterator.- Specified by:
getProperties
in interfaceSequenceIterator
- Returns:
- the properties of this iterator. This will be some combination of
properties such as
SequenceIterator.Property.GROUNDED
,SequenceIterator.Property.LAST_POSITION_FINDER
, andSequenceIterator.Property.LOOKAHEAD
. It is always acceptable to return the default valueEnumSet.noneOf(Property.class)
, indicating that there are no known special properties. It is acceptable (though unusual) for the properties of the iterator to change depending on its state.
-