|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.tree.iter.SingletonIterator<T>
public class SingletonIterator<T extends Item>
SingletonIterator: an iterator over a sequence of zero or one values
Field Summary |
---|
Fields inherited from interface net.sf.saxon.om.SequenceIterator |
---|
GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD |
Method Summary | ||
---|---|---|
void |
close()
Close the iterator. |
|
T |
current()
Get the current value in the sequence (the one returned by the most recent call on next()). |
|
SingletonIterator<T> |
getAnother()
Get another SequenceIterator that iterates over the same items as the original, but which is repositioned at the start of the sequence. |
|
int |
getLength()
Get the last position (that is, the number of items in the sequence). |
|
int |
getProperties()
Get properties of this iterator, as a bit-significant integer. |
|
SingletonIterator<T> |
getReverseIterator()
Get a new SequenceIterator that returns the same items in reverse order. |
|
T |
getValue()
|
|
boolean |
hasNext()
Determine whether there are more items to come. |
|
static
|
makeIterator(T item)
Factory method. |
|
GroundedValue |
materialize()
Return a Value containing all the items in the sequence returned by this SequenceIterator |
|
T |
next()
Get the next item in the sequence. |
|
int |
position()
Return the current position in the sequence. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static <T extends Item> UnfailingIterator<T> makeIterator(T item)
item
- the item to iterate over
public boolean hasNext()
hasNext
in interface LookaheadIterator<T extends Item>
public T next()
SequenceIterator
next
in interface SequenceIterator<T extends Item>
next
in interface UnfailingIterator<T extends Item>
public T current()
SequenceIterator
current
in interface SequenceIterator<T extends Item>
current
in interface UnfailingIterator<T extends Item>
public int position()
position
in interface SequenceIterator<T extends Item>
position
in interface UnfailingIterator<T extends Item>
public int getLength()
LastPositionFinder
SequenceIterator.LAST_POSITION_FINDER
getLength
in interface LastPositionFinder<T extends Item>
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<T extends Item>
public SingletonIterator<T> getAnother()
SequenceIterator
This method allows access to all the items in the sequence without disturbing the current position of the iterator. Internally, its main use is in evaluating the last() function.
This method does not change the state of the iterator.
getAnother
in interface SequenceIterator<T extends Item>
getAnother
in interface UnfailingIterator<T extends Item>
public SingletonIterator<T> getReverseIterator()
ReversibleIterator
getReverseIterator
in interface ReversibleIterator<T extends Item>
public T getValue()
public GroundedValue materialize()
materialize
in interface GroundedIterator<T extends Item>
public int getProperties()
getProperties
in interface SequenceIterator<T extends Item>
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |