net.sf.saxon.tinytree

Class SiblingEnumeration

final class SiblingEnumeration extends AxisIteratorImpl implements LookaheadIterator

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 enumeration using NodeInfo#getEnumeration()
Constructor Summary
SiblingEnumeration(TinyTree tree, TinyNodeImpl node, NodeTest nodeTest, boolean getChildren)
Return an enumeration over children or siblings of the context node
Method Summary
Valueatomize()
Return the atomized value of the current node.
Itemcurrent()
Get the current node in the sequence.
SequenceIteratorgetAnother()
Get another enumeration of the same nodes
intgetProperties()
CharSequencegetStringValue()
Return the string value of the current node.
booleanhasNext()
Test whether there are any more nodes to come.
booleanmoveNext()
Itemnext()
Return the next node in the sequence

Constructor Detail

SiblingEnumeration

SiblingEnumeration(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

atomize

public Value atomize()
Return the atomized value of the current node. This is achieved in common cases without actually instantiating the NodeInfo object

Returns: the atomized value.

Throws: NullPointerException if there is no current node

current

public Item current()
Get the current node in the sequence.

Returns: the node returned by the most recent call on next(), or the one on which we have positioned using moveNext().

getAnother

public SequenceIterator getAnother()
Get another enumeration of the same nodes

getProperties

public int getProperties()

getStringValue

public CharSequence getStringValue()
Return the string value of the current node.

Returns: the string value, as an instance of CharSequence.

Throws: NullPointerException if there is no current node

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.

Returns: true if there are more items in the sequence

moveNext

public boolean moveNext()

next

public Item next()
Return the next node in the sequence

Returns: the next node, or null if the end of the sequence is reached