Package net.sf.saxon.tree.iter

Class ListIterator.Of<T extends Item>

java.lang.Object

net.sf.saxon.tree.iter.ListIterator

net.sf.saxon.tree.iter.ListIterator.Of<T>

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, LastPositionFinder, SequenceIterator, GroundedIterator, LookaheadIterator, ReversibleIterator

Direct Known Subclasses:

ListIterator.OfAtomic, NodeListIterator

Enclosing class:

ListIterator

public static class ListIterator.Of<T extends Item>
extends ListIterator

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.saxon.tree.iter.ListIterator

ListIterator.Of<T extends Item>, ListIterator.OfAtomic<A extends AtomicValue>

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<T>	list

Constructor Summary

Constructors

Constructor	Description
Of(java.util.List<T> list)	Create a ListIterator over a given List

Method Summary

Modifier and Type	Method	Description
int	getLength()	Get the last position (that is, the number of items in the sequence).
GroundedValue	getResidue()	Return a GroundedValue containing all the remaining items in the sequence returned by this SequenceIterator, starting at the current position.
SequenceIterator	getReverseIterator()	Get a new SequenceIterator that returns the same items in reverse order.
boolean	hasNext()	Determine whether there are more items to come.
boolean	isActuallyGrounded()	Ask if the iterator is actually grounded.
GroundedValue	materialize()	Return a Sequence containing all the items in the sequence returned by this SequenceIterator
Item	next()	Get the next item in the sequence.
boolean	supportsGetLength()	Ask whether this iterator supports use of the LastPositionFinder.getLength() method.

Methods inherited from class net.sf.saxon.tree.iter.ListIterator

supportsHasNext

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, discharge

Field Detail

list

protected java.util.List<T extends Item> list

Constructor Detail

Of

public Of(java.util.List<T> list)

Create a ListIterator over a given List

Parameters:

list - the list: all objects in the list must be instances of Item

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 LookaheadIterator.supportsHasNext() is true.

Returns:

true if there are more items in the sequence

next

public Item next()

Description copied from interface: SequenceIterator

Get the next item in the sequence. This method changes the state of the iterator.

Returns:

the next item, or null if there are no more items. Once a call on next() has returned null, no further calls should be made. The preferred action for an iterator if subsequent calls on next() are made is to return null again, and all implementations within Saxon follow this rule.

supportsGetLength

public boolean supportsGetLength()

Description copied from interface: LastPositionFinder

Ask whether this iterator supports use of the LastPositionFinder.getLength() method. This method should always be called before calling LastPositionFinder.getLength(), because an iterator that implements this interface may support use of LastPositionFinder.getLength() in some situations and not in others

Returns:

true if the LastPositionFinder.getLength() method can be called to determine the length of the underlying sequence.

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 LastPositionFinder.supportsGetLength() has been called and has returned true.

Returns:

the number of items in the sequence

isActuallyGrounded

public boolean isActuallyGrounded()

Description copied from interface: GroundedIterator

Ask if the iterator is actually grounded. This method must be called before calling GroundedIterator.materialize() or GroundedIterator.getResidue(), because the iterator might be grounded under some conditions and not others (usually when it delegates to another iterator)

Returns:

true if this iterator is grounded

materialize

public GroundedValue materialize()

Return a Sequence containing all the items in the sequence returned by this SequenceIterator

Returns:

the corresponding GroundedValue

getResidue

public 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).

Returns:

the corresponding Value

getReverseIterator

public SequenceIterator 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.

Returns:

an iterator over the items in reverse order