net.sf.saxon.tree.iter

Class ReverseListIterator<T extends Item<?>>

java.lang.Object

net.sf.saxon.tree.iter.ReverseListIterator<T>

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, LastPositionFinder, SequenceIterator<T>, LookaheadIterator<T>, ReversibleIterator<T>, UnfailingIterator<T>

public class ReverseListIterator<T extends Item<?>>
extends java.lang.Object
implements UnfailingIterator<T>, ReversibleIterator<T>, LookaheadIterator<T>, LastPositionFinder

ReverseListIterator is used to enumerate items held in an array in reverse order.

Author:

Michael H. Kay

Field Summary

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

ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

Constructors

Constructor and Description
ReverseListIterator(java.util.List<T> items) Create an iterator a slice of an array

Method Summary

Modifier and Type	Method and Description
void	close() Close the iterator.
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.
SequenceIterator<T>	getReverseIterator() Get an iterator that processes the same items in reverse order.
boolean	hasNext() Determine whether there are more items to come.
T	next() 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.tree.iter.UnfailingIterator

firstWith, forEach, toGroundedValue, toList

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

forEachOrFail, materialize

Constructor Detail

ReverseListIterator

public ReverseListIterator(java.util.List<T> items)

Create an iterator a slice of an array

Parameters:

items - The list of items

Method Detail

hasNext

public boolean hasNext()

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.

Specified by:

hasNext in interface LookaheadIterator<T extends Item<?>>

Returns:

true if there are more items in the sequence

next

public T next()

Description copied from interface: UnfailingIterator

Get the next item in the sequence.

Specified by:

next in interface SequenceIterator<T extends Item<?>>

Specified by:

next in interface UnfailingIterator<T extends Item<?>>

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 setting SequenceIterator.LAST_POSITION_FINDER

Specified by:

getLength in interface LastPositionFinder

Returns:

the number of items in the sequence

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.

For example, the iterator returned by the unparsed-text-lines() function has a close() method that causes the underlying input stream to be closed, whether or not the file has been read to completion.

Closing an iterator is important 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 interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface SequenceIterator<T extends Item<?>>

getProperties

public int getProperties()

Get properties of this iterator, as a bit-significant integer.

Specified by:

getProperties in interface SequenceIterator<T extends Item<?>>

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.

getReverseIterator

public SequenceIterator<T> getReverseIterator()

Get an iterator that processes the same items in reverse order. Since this iterator is processing the items backwards, this method returns an ArrayIterator that processes them forwards.

Specified by:

getReverseIterator in interface ReversibleIterator<T extends Item<?>>

Returns:

a new ArrayIterator