public class ManualIterator extends java.lang.Object implements FocusIterator, UnfailingIterator, ReversibleIterator, LastPositionFinder, GroundedIterator, LookaheadIterator
ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
Constructor and Description |
---|
ManualIterator()
Create an uninitialized ManualIterator: this is only usable after the context item, position, and size (if required)
have been initialized using setter methods.
|
ManualIterator(Item value)
Create a ManualIterator supplying the context item, and setting the value of
both "position()" and "last()" implicitly to 1.
|
ManualIterator(Item value,
int position)
Create a ManualIterator initializing the context item and position.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the iterator.
|
Item |
current()
Get the current value in the sequence (the one returned by the
most recent call on next()).
|
int |
getLength()
Get the position of the last item in the sequence
|
int |
getProperties()
Get properties of this iterator, as a bit-significant integer.
|
GroundedValue |
getResidue()
Return a GroundedValue containing all the remaining items in the sequence returned by this
SequenceIterator, starting at the current position.
|
ManualIterator |
getReverseIterator()
Get a new SequenceIterator that returns the same items in reverse order.
|
boolean |
hasNext()
Determine whether there are more items to come.
|
void |
incrementPosition() |
GroundedValue |
materialize()
Return a Value containing all the items in the sequence returned by this
SequenceIterator
|
Item |
next()
Get the next item in the sequence.
|
int |
position()
Return the current position in the sequence.
|
void |
setContextItem(Item value) |
void |
setLastPositionFinder(LastPositionFinder finder) |
void |
setPosition(int position) |
public ManualIterator()
public ManualIterator(Item value, int position)
value
- the context item. May be null if the value is to be initialized later.position
- the context positionpublic ManualIterator(Item value)
value
- the context itempublic void setContextItem(Item value)
public void setLastPositionFinder(LastPositionFinder finder)
public void incrementPosition()
public void setPosition(int position)
public boolean hasNext()
hasNext
in interface LookaheadIterator
public Item next()
SequenceIterator
next
in interface SequenceIterator
next
in interface UnfailingIterator
public Item current()
FocusIterator
current
in interface FocusIterator
public int position()
position
in interface FocusIterator
public int getLength() throws XPathException
FocusIterator
getLength
in interface LastPositionFinder
getLength
in interface FocusIterator
XPathException
- if a failure occurs reading the sequencepublic 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 ManualIterator getReverseIterator()
ReversibleIterator
getReverseIterator
in interface ReversibleIterator
public GroundedValue materialize()
materialize
in interface GroundedIterator
public GroundedValue getResidue() throws XPathException
GroundedIterator
getResidue
in interface GroundedIterator
XPathException
- in the cases of subclasses (such as the iterator over a MemoClosure)
which cause evaluation of expressions while materializing the value.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.Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.