Package net.sf.saxon.tree.iter

Class PrependSequenceIterator<T extends Item<?>>

java.lang.Object

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

All Implemented Interfaces:

Closeable, AutoCloseable, SequenceIterator<T>

Direct Known Subclasses:

PrependAxisIterator

public class PrependSequenceIterator<T extends Item<?>>
extends Object
implements SequenceIterator<T>

An iterator over nodes, that prepends a given node to the nodes returned by another iterator. Used to modify an iterator over axis A to one that iterates over A-OR-SELF.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) SequenceIterator<T>	base
(package private) T	start

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

ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

Constructors

Constructor	Description
PrependSequenceIterator(T start, SequenceIterator<T> base)

Method Summary

Modifier and Type	Method	Description
void	close()	Close the iterator.
int	getProperties()	Get properties of this iterator, as a bit-significant integer.
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.om.SequenceIterator

forEachOrFail, materialize

Field Detail

start

T extends Item<?> start

base

SequenceIterator<T extends Item<?>> base

Constructor Detail

PrependSequenceIterator

public PrependSequenceIterator(T start,
                               SequenceIterator<T> base)

Method Detail

next

public T next()
       throws XPathException

Get the next item in the sequence.

Specified by:

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

Returns:

the next Item. If there are no more items, return null.

Throws:

XPathException - if an error occurs retrieving the next item

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 AutoCloseable

Specified by:

close in interface Closeable

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.