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
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()
-
-
Constructor Summary
Constructors Constructor Description SiblingIterator(TinyTree tree, TinyNodeImpl node, NodeTest nodeTest, boolean getChildren)
Return an enumeration over children or siblings of the context node
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
hasNext()
Test whether there are any more nodes to come.NodeInfo
next()
Return the next node in the sequenceAtomicSequence
nextAtomizedValue()
Deliver the atomic value that is next in the atomized resultboolean
supportsHasNext()
Ask whether the hasNext() method can be called.-
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 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 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 Detail
-
next
public NodeInfo next()
Return the next node in the sequence- Specified by:
next
in interfaceAxisIterator
- Specified by:
next
in interfaceSequenceIterator
- 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 interfaceAtomizedValueIterator
- Returns:
- the next atomic value
- Throws:
XPathException
- if a failure occurs reading or atomizing the next value
-
supportsHasNext
public boolean supportsHasNext()
Description copied from interface:LookaheadIterator
Ask whether the hasNext() method can be called. This method must be called before calling hasNext(), because some iterators implement this interface, but only support look-ahead under particular circumstances (this is usually because they delegate to another iterator)- Specified by:
supportsHasNext
in interfaceLookaheadIterator
- Returns:
- true if the
LookaheadIterator.hasNext()
method is available
-
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
-
-