Package net.sf.saxon.tree.wrapper
Class WrappingIterator
java.lang.Object
net.sf.saxon.tree.wrapper.WrappingIterator
- All Implemented Interfaces:
Closeable,AutoCloseable,SequenceIterator,AxisIterator,UnfailingIterator
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.
-
Nested Class Summary
Nested classes/interfaces inherited from interface net.sf.saxon.om.SequenceIterator
SequenceIterator.Property -
Field Summary
FieldsModifier and TypeFieldDescription(package private) boolean(package private) AxisIterator(package private) NodeInfo(package private) VirtualNode(package private) WrappingFunction -
Constructor Summary
ConstructorsConstructorDescriptionWrappingIterator(AxisIterator base, WrappingFunction function, VirtualNode parent) Create a WrappingIterator -
Method Summary
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface net.sf.saxon.tree.iter.AxisIterator
asIterator, forEachNodeMethods inherited from interface net.sf.saxon.om.SequenceIterator
forEachOrFail, getProperties, materializeMethods inherited from interface net.sf.saxon.tree.iter.UnfailingIterator
forEach, toList
-
Field Details
-
base
AxisIterator base -
parent
VirtualNode parent -
current
NodeInfo current -
atomizing
boolean atomizing -
wrappingFunction
WrappingFunction wrappingFunction
-
-
Constructor Details
-
WrappingIterator
Create a WrappingIterator- Parameters:
base- The underlying iteratorparent- If all the nodes to be wrapped have the same parent, it can be specified here. Otherwise specify null.
-
-
Method Details
-
next
Description copied from interface:UnfailingIteratorGet the next item in the sequence.- Specified by:
nextin interfaceAxisIterator- Specified by:
nextin interfaceSequenceIterator- Specified by:
nextin interfaceUnfailingIterator- Returns:
- the next Item. If there are no more items, return null.
-
current
-
close
public void close()Description copied from interface:SequenceIteratorClose 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:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein interfaceSequenceIterator
-