Package net.sf.saxon.om
Class ListIterator
- java.lang.Object
-
- net.sf.saxon.om.ListIterator
-
- All Implemented Interfaces:
LastPositionFinder
,GroundedIterator
,LookaheadIterator
,SequenceIterator
,UnfailingIterator
- Direct Known 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
-
-
Field Summary
-
Fields inherited from interface net.sf.saxon.om.SequenceIterator
GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
-
-
Constructor Summary
Constructors Constructor Description ListIterator(java.util.List list)
Create a ListIterator over a given ListListIterator(java.util.List list, int length)
Create a ListIterator over the leading part of a given List
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Close the iterator.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 SequenceIteratorItem
next()
Get the next item in the sequence.int
position()
Get the current position
-
-
-
Constructor Detail
-
ListIterator
public ListIterator(java.util.List list)
Create a ListIterator over a given List- Parameters:
list
- the list: all objects in the list must be instances ofItem
-
ListIterator
public ListIterator(java.util.List list, int length)
Create a ListIterator over the leading part of a given List- Parameters:
list
- the list: all objects in the list must be instances ofItem
length
- the number of items to be included
-
-
Method Detail
-
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 bit settingSequenceIterator.LOOKAHEAD
- Specified by:
hasNext
in interfaceLookaheadIterator
- Returns:
- true if there are more items in the sequence
-
next
public Item 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 nodes, return null.
-
current
public Item current()
Description copied from interface:UnfailingIterator
Get the current item in the sequence.- Specified by:
current
in interfaceSequenceIterator
- Specified by:
current
in interfaceUnfailingIterator
- Returns:
- the current item, that is, the item most recently returned by next()
-
position
public int position()
Description copied from interface:UnfailingIterator
Get the current position- Specified by:
position
in interfaceSequenceIterator
- Specified by:
position
in interfaceUnfailingIterator
- Returns:
- the position of the current item (the item most recently returned by next()), starting at 1 for the first node
-
close
public void close()
Description copied from interface:SequenceIterator
Close the iterator. This indicates to the supplier of the data that the client does not require any more items to be delivered by the iterator. This may enable the supplier to release resources. After calling close(), no further calls on the iterator should be made; if further calls are made, the effect of such calls is undefined.(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.)
- Specified by:
close
in interfaceSequenceIterator
-
getLastPosition
public int getLastPosition()
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.LAST_POSITION_FINDER
- Specified by:
getLastPosition
in interfaceLastPositionFinder
-
getAnother
public SequenceIterator getAnother()
Description copied from interface:UnfailingIterator
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 interfaceSequenceIterator
- Specified by:
getAnother
in interfaceUnfailingIterator
- Returns:
- a new iterator over the same sequence
-
getProperties
public int 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.GROUNDED
,SequenceIterator.LAST_POSITION_FINDER
, andSequenceIterator.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
public GroundedValue materialize()
Return a SequenceValue containing all the items in the sequence returned by this SequenceIterator- Specified by:
materialize
in interfaceGroundedIterator
- Returns:
- the corresponding SequenceValue
-
-