net.sf.saxon.om

Class ListIterator

Implemented Interfaces:
GroundedIterator, LastPositionFinder, LookaheadIterator, SequenceIterator, UnfailingIterator
Known Direct Subclasses:
NodeListIterator

public class ListIterator
extends java.lang.Object
implements UnfailingIterator, LastPositionFinder, LookaheadIterator, GroundedIterator

Class ListIterator, iterates over a sequence of items held in a Java ArrayList, or indeed in any other kind of List

Fields inherited from interface net.sf.saxon.om.SequenceIterator

GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

ListIterator(List list)
Create a ListIterator over a given List
ListIterator(List list, int length)
Create a ListIterator over the leading part of a given List

Method Summary

Item
current()
Get the current item in the sequence.
SequenceIterator
getAnother()
Get another iterator over the same sequence of items, positioned at the start of the sequence.
int
getLastPosition()
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.
boolean
hasNext()
Determine whether there are more items to come.
GroundedValue
materialize()
Return a SequenceValue containing all the items in the sequence returned by this SequenceIterator
Item
next()
Get the next item in the sequence.
int
position()
Get the current position

Constructor Details

ListIterator

public ListIterator(List list)
Create a ListIterator over a given List

ListIterator

public ListIterator(List list,
                    int length)
Create a ListIterator over the leading part of a given List

Method Details

current

public Item current()
Get the current item in the sequence.
Specified by:
current in interface UnfailingIterator
current in interface SequenceIterator
Returns:
the current item, that is, the item most recently returned by next()

getAnother

public SequenceIterator getAnother()
Get another iterator over the same sequence of items, positioned at the start of the sequence. It must be possible to call this method at any time, whether none, some, or all of the items in the original iterator have been read. The method is non-destructive: it does not change the state of the original iterator.
Specified by:
getAnother in interface UnfailingIterator
getAnother in interface SequenceIterator
Returns:
a new iterator over the same sequence

getLastPosition

public int getLastPosition()
Specified by:
getLastPosition in interface LastPositionFinder

getProperties

public int getProperties()
Get properties of this iterator, as a bit-significant integer.
Specified by:
getProperties in interface SequenceIterator
Returns:
the properties of this iterator. This will be some combination of properties such as 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.

hasNext

public boolean hasNext()
Specified by:
hasNext in interface LookaheadIterator
Returns:
true if there are more items in the sequence

materialize

public GroundedValue materialize()
Return a SequenceValue containing all the items in the sequence returned by this SequenceIterator
Specified by:
materialize in interface GroundedIterator
Returns:
the corresponding SequenceValue

next

public Item next()
Get the next item in the sequence.
Specified by:
next in interface UnfailingIterator
next in interface SequenceIterator
Returns:
the next Item. If there are no more nodes, return null.

position

public int position()
Get the current position
Specified by:
position in interface UnfailingIterator
position in interface SequenceIterator
Returns:
the position of the current item (the item most recently returned by next()), starting at 1 for the first node