net.sf.saxon.tree.iter

Class SingleAtomicIterator

java.lang.Object

net.sf.saxon.tree.iter.SingleAtomicIterator

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, LastPositionFinder, SequenceIterator<AtomicValue>, AtomicIterator, GroundedIterator<AtomicValue>, LookaheadIterator<AtomicValue>, ReversibleIterator<AtomicValue>, UnfailingIterator<AtomicValue>

public class SingleAtomicIterator
extends java.lang.Object
implements AtomicIterator, ReversibleIterator<AtomicValue>, LastPositionFinder, GroundedIterator<AtomicValue>, LookaheadIterator<AtomicValue>

SingletonIterator: an iterator over a sequence of zero or one values

Field Summary

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

ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

Constructors

Constructor and Description
SingleAtomicIterator(AtomicValue value) Private constructor: external classes should use the factory method

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.
GroundedValue<AtomicValue>	getResidue() Return a GroundedValue containing all the remaining items in the sequence returned by this SequenceIterator, starting at the current position.
SingleAtomicIterator	getReverseIterator() Get a new SequenceIterator that returns the same items in reverse order.
boolean	hasNext() Determine whether there are more items to come.
GroundedValue<AtomicValue>	materialize() Return a Value containing all the items in the sequence returned by this SequenceIterator
AtomicValue	next() Get the next atomic value 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

Constructor Detail

SingleAtomicIterator

public SingleAtomicIterator(AtomicValue value)

Private constructor: external classes should use the factory method

Parameters:

value - the item to iterate over

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<AtomicValue>

Returns:

true if there are more items

next

public AtomicValue next()

Description copied from interface: AtomicIterator

Get the next atomic value in the sequence.

Specified by:

next in interface SequenceIterator<AtomicValue>

Specified by:

next in interface AtomicIterator

Specified by:

next in interface UnfailingIterator<AtomicValue>

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<AtomicValue>

getReverseIterator

public SingleAtomicIterator 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 interface ReversibleIterator<AtomicValue>

Returns:

an iterator over the items in reverse order

materialize

public GroundedValue<AtomicValue> materialize()

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

Specified by:

materialize in interface SequenceIterator<AtomicValue>

Specified by:

materialize in interface GroundedIterator<AtomicValue>

Returns:

the corresponding Value. If the value is a closure or a function call package, it will be evaluated and expanded.

getResidue

public GroundedValue<AtomicValue> 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 interface GroundedIterator<AtomicValue>

Returns:

the corresponding Value

getProperties

public int getProperties()

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

Specified by:

getProperties in interface SequenceIterator<AtomicValue>

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.