Package net.sf.saxon.tree.wrapper

Class WrappingIterator

java.lang.Object

net.sf.saxon.tree.wrapper.WrappingIterator

All Implemented Interfaces:

Closeable, AutoCloseable, SequenceIterator<NodeInfo>, AxisIterator, UnfailingIterator<NodeInfo>

public class WrappingIterator
extends Object
implements AxisIterator

A WrappingIterator delivers wrappers for the nodes delivered by its underlying iterator. It is used when no whitespace stripping is actually needed, e.g. for the attribute axis. But we still need to create wrappers, so that further iteration remains in the virtual layer rather than switching to the real nodes.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	atomizing
(package private) AxisIterator	base
(package private) NodeInfo	current
(package private) VirtualNode	parent
(package private) WrappingFunction	wrappingFunction

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

ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

Constructors

Constructor	Description
WrappingIterator(AxisIterator base, WrappingFunction function, VirtualNode parent)	Create a WrappingIterator

Method Summary

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

Methods inherited from interface net.sf.saxon.tree.iter.UnfailingIterator

firstWith, forEach, toGroundedValue, toList

Field Detail

base

AxisIterator base

parent

VirtualNode parent

current

NodeInfo current

atomizing

boolean atomizing

wrappingFunction

WrappingFunction wrappingFunction

Constructor Detail

WrappingIterator

public WrappingIterator(AxisIterator base,
                        WrappingFunction function,
                        VirtualNode parent)

Create a WrappingIterator

Parameters:

base - The underlying iterator

parent - If all the nodes to be wrapped have the same parent, it can be specified here. Otherwise specify null.

Method Detail

next

public NodeInfo next()

Description copied from interface: UnfailingIterator

Get the next item in the sequence.

Specified by:

next in interface AxisIterator

Specified by:

next in interface SequenceIterator<NodeInfo>

Specified by:

next in interface UnfailingIterator<NodeInfo>

Returns:

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

current

public NodeInfo current()

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

getProperties

public int getProperties()

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

Specified by:

getProperties in interface SequenceIterator<NodeInfo>

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.