Package net.sf.saxon.tree.iter
Class ListIterator<T extends Item>
java.lang.Object
net.sf.saxon.tree.iter.ListIterator<T>
- All Implemented Interfaces:
Closeable
,AutoCloseable
,LastPositionFinder
,SequenceIterator
,GroundedIterator
,LookaheadIterator
,ReversibleIterator
,UnfailingIterator
- Direct Known Subclasses:
ListIterator.Atomic
,ListIterator.OfNodes
public class ListIterator<T extends Item>
extends Object
implements UnfailingIterator, LastPositionFinder, LookaheadIterator, GroundedIterator, ReversibleIterator
Class ListIterator, iterates over a sequence of items held in a Java List
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
Nested classes/interfaces inherited from interface net.sf.saxon.om.SequenceIterator
SequenceIterator.Property
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
Get the last position (that is, the number of items in the sequence).Get properties of this iterator, as a bit-significant integer.Return a GroundedValue containing all the remaining items in the sequence returned by this SequenceIterator, starting at the current position.Get a new SequenceIterator that returns the same items in reverse order.boolean
hasNext()
Determine whether there are more items to come.Return a Sequence containing all the items in the sequence returned by this SequenceIteratornext()
Get the next item in the sequence.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface net.sf.saxon.om.SequenceIterator
close, forEachOrFail
Methods inherited from interface net.sf.saxon.tree.iter.UnfailingIterator
forEach, toList
-
Field Details
-
list
-
-
Constructor Details
-
ListIterator
Create a ListIterator over a given List- Parameters:
list
- the list: all objects in the list must be instances ofItem
-
-
Method Details
-
hasNext
public boolean hasNext()Description copied from interface:LookaheadIterator
Determine whether there are more items to come. Note that this operation is stateless and it is not necessary (or usual) to call it before calling next(). It is used only when there is an explicit need to tell if we are at the last element.This method must not be called unless the result of getProperties() on the iterator includes the property
SequenceIterator.Property.LOOKAHEAD
- Specified by:
hasNext
in interfaceLookaheadIterator
- Returns:
- true if there are more items in the sequence
-
next
Description copied from interface:UnfailingIterator
Get the next item in the sequence.- Specified by:
next
in interfaceSequenceIterator
- Specified by:
next
in interfaceUnfailingIterator
- Returns:
- the next Item. If there are no more items, return null.
-
getLength
public int getLength()Description copied from interface:LastPositionFinder
Get the last position (that is, the number of items in the sequence). This method is non-destructive: it does not change the state of the iterator. The result is undefined if the next() method of the iterator has already returned null. This method must not be called unless the result of getProperties() on the iterator includes the bit settingSequenceIterator.Property.LAST_POSITION_FINDER
- Specified by:
getLength
in interfaceLastPositionFinder
- Returns:
- the number of items in the sequence
-
getProperties
Get properties of this iterator, as a bit-significant integer.- Specified by:
getProperties
in interfaceSequenceIterator
- Returns:
- the properties of this iterator. This will be some combination of
properties such as
SequenceIterator.Property.GROUNDED
,SequenceIterator.Property.LAST_POSITION_FINDER
, andSequenceIterator.Property.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.
-
materialize
Return a Sequence containing all the items in the sequence returned by this SequenceIterator- Specified by:
materialize
in interfaceGroundedIterator
- Specified by:
materialize
in interfaceSequenceIterator
- Returns:
- the corresponding GroundedValue
-
getResidue
Description copied from interface:GroundedIterator
Return a GroundedValue containing all the remaining items in the sequence returned by this SequenceIterator, starting at the current position. This should be an "in-memory" value, not a Closure. This method does not change the state of the iterator (in particular, it does not consume the iterator).- Specified by:
getResidue
in interfaceGroundedIterator
- Returns:
- the corresponding Value
-
getReverseIterator
Description copied from interface:ReversibleIterator
Get a new SequenceIterator that returns the same items in reverse order. If this SequenceIterator is an AxisIterator, then the returned SequenceIterator must also be an AxisIterator.- Specified by:
getReverseIterator
in interfaceReversibleIterator
- Returns:
- an iterator over the items in reverse order
-