Class WrappingIterator

java.lang.Object
net.sf.saxon.tree.wrapper.WrappingIterator
All Implemented Interfaces:
Closeable, AutoCloseable, SequenceIterator, AxisIterator, UnfailingIterator

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 Details

  • Constructor Details

    • 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 Details

    • 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
      Specified by:
      next in interface UnfailingIterator
      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