public class EmptyIterator extends Object implements AxisIterator, ReversibleIterator, LastPositionFinder, GroundedIterator, LookaheadIterator
GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
Modifier and Type | Method and Description |
---|---|
Value |
atomize()
Return the atomized value of the current node.
|
void |
close()
Close the iterator.
|
Item |
current()
Get the current item, that is, the item returned by the most recent call of next().
|
SequenceIterator |
getAnother()
Get another iterator over the same items, positioned at the start.
|
static EmptyIterator |
getInstance()
Get an EmptyIterator, an iterator over an empty sequence.
|
int |
getLastPosition()
Get the position of the last item in the sequence.
|
int |
getProperties()
Get properties of this iterator, as a bit-significant integer.
|
SequenceIterator |
getReverseIterator()
Get another iterator over the same items, in reverse order.
|
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.
|
GroundedValue |
materialize()
Return a Value containing all the items in the sequence returned by this
SequenceIterator.
|
boolean |
moveNext()
Move to the next node, without returning it.
|
Item |
next()
Get the next item.
|
int |
position()
Get the position of the current item.
|
public static EmptyIterator getInstance()
public boolean moveNext()
moveNext
in interface AxisIterator
public Item next()
next
in interface SequenceIterator
next
in interface UnfailingIterator
public Item current()
current
in interface SequenceIterator
current
in interface UnfailingIterator
public int position()
position
in interface SequenceIterator
position
in interface UnfailingIterator
public int getLastPosition()
getLastPosition
in interface LastPositionFinder
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.NullPointerException
- if there is no current nodepublic Value atomize() throws XPathException
atomize
in interface AxisIterator
NullPointerException
- if there is no current nodeXPathException
public CharSequence getStringValue()
getStringValue
in interface AxisIterator
NullPointerException
- if there is no current nodepublic SequenceIterator getAnother()
getAnother
in interface SequenceIterator
getAnother
in interface UnfailingIterator
public SequenceIterator getReverseIterator()
getReverseIterator
in interface ReversibleIterator
public 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.public GroundedValue materialize()
materialize
in interface GroundedIterator
public boolean hasNext()
hasNext
in interface LookaheadIterator