net.sf.saxon.tree.iter

Class AdjacentTextNodeMergingIterator

java.lang.Object

net.sf.saxon.tree.iter.AdjacentTextNodeMergingIterator

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, SequenceIterator, LookaheadIterator

public class AdjacentTextNodeMergingIterator
extends java.lang.Object
implements LookaheadIterator

AdjacentTextNodeMergingIterator is an iterator that eliminates zero-length text nodes and merges adjacent text nodes from the underlying iterator

Nested Class Summary

Nested classes/interfaces inherited from interface net.sf.saxon.om.SequenceIterator

SequenceIterator.Property

Constructor Summary

Constructors

Constructor and Description
AdjacentTextNodeMergingIterator(SequenceIterator base)

Method Summary

Modifier and Type	Method and Description
void	close() Close the iterator.
java.util.EnumSet<SequenceIterator.Property>	getProperties() Get properties of this iterator.
boolean	hasNext() Determine whether there are more items to come.
Item	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

Constructor Detail

AdjacentTextNodeMergingIterator

public AdjacentTextNodeMergingIterator(SequenceIterator base)
                                throws XPathException

Throws:

XPathException

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 property SequenceIterator.Property.LOOKAHEAD

Specified by:

hasNext in interface LookaheadIterator

Returns:

true if there are more items in the sequence

next

public Item next()
          throws XPathException

Description copied from interface: SequenceIterator

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

Specified by:

next in interface SequenceIterator

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.

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 java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface SequenceIterator

getProperties

public java.util.EnumSet<SequenceIterator.Property> getProperties()

Description copied from interface: SequenceIterator

Get properties of this iterator.

Specified by:

getProperties in interface SequenceIterator

Returns:

the properties of this iterator. This will be some combination of properties such as SequenceIterator.Property.GROUNDED, SequenceIterator.Property.LAST_POSITION_FINDER, and SequenceIterator.Property.LOOKAHEAD. It is always acceptable to return the default value EnumSet.noneOf(Property.class), indicating that there are no known special properties. It is acceptable (though unusual) for the properties of the iterator to change depending on its state.