abstract class TreeEnumeration extends java.lang.Object implements AxisIterator, LookaheadIterator
Modifier and Type | Field and Description |
---|---|
protected NodeImpl |
current |
protected NodeImpl |
next |
protected NodeTest |
nodeTest |
protected int |
position |
protected NodeImpl |
start |
GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
Constructor and Description |
---|
TreeEnumeration(NodeImpl origin,
NodeTest nodeTest)
Create an axis enumeration for a given type and name of node, from a given
origin node
|
Modifier and Type | Method and Description |
---|---|
protected void |
advance()
Advance along the axis until a node is found that matches the required criteria
|
Value |
atomize()
Return the atomized value of the current node.
|
void |
close()
Close the iterator.
|
protected boolean |
conforms(NodeImpl node)
Test whether a node conforms to the node type and name constraints.
|
NodeInfo |
current()
Return the current Item
|
int |
getProperties()
Get properties of this iterator, as a bit-significant integer.
|
java.lang.CharSequence |
getStringValue()
Return the string value of the current node.
|
boolean |
hasNext()
Determine whether there are more items to come.
|
AxisIterator |
iterateAxis(byte axis,
NodeTest test)
Return an iterator over an axis, starting at the current node.
|
boolean |
moveNext()
Move to the next node, without returning it.
|
NodeInfo |
next()
Return the next node in the enumeration
|
int |
position()
Return the current position
|
protected abstract void |
step()
Advance one step along the axis: the resulting node might not meet the required
criteria for inclusion
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getAnother
protected NodeImpl start
protected NodeImpl next
protected NodeTest nodeTest
protected NodeImpl current
protected int position
public TreeEnumeration(NodeImpl origin, NodeTest nodeTest)
origin
- the node from which the axis originatesnodeTest
- test to be satisfied by the returned nodes, or null if all nodes
are to be returned.protected boolean conforms(NodeImpl node)
node
- the node to be testedprotected final void advance()
protected abstract void step()
public boolean hasNext()
hasNext
in interface LookaheadIterator
public boolean moveNext()
moveNext
in interface AxisIterator
public final NodeInfo next()
next
in interface SequenceIterator
next
in interface AxisIterator
next
in interface UnfailingIterator
public final NodeInfo current()
current
in interface SequenceIterator
current
in interface AxisIterator
current
in interface UnfailingIterator
public final int position()
position
in interface SequenceIterator
position
in interface UnfailingIterator
public void close()
SequenceIterator
(Currently, closing an iterator is important only 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.)
close
in interface SequenceIterator
public AxisIterator iterateAxis(byte axis, NodeTest test)
iterateAxis
in interface AxisIterator
axis
- the axis to iterate over, using a constant such as
Axis.CHILD
test
- a predicate to apply to the nodes before returning them.java.lang.NullPointerException
- if there is no current nodepublic Value atomize() throws XPathException
atomize
in interface AxisIterator
java.lang.NullPointerException
- if there is no current nodeXPathException
- if the current node
cannot be atomized, for example because it is an element node with
element-only content.public java.lang.CharSequence getStringValue()
getStringValue
in interface AxisIterator
java.lang.NullPointerException
- if there is no current nodepublic int getProperties()
getProperties
in interface SequenceIterator
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.