Package net.sf.saxon.tree.iter

Class NodeWrappingAxisIterator<B>

java.lang.Object
net.sf.saxon.tree.iter.NodeWrappingAxisIterator<B>
Type Parameters:
B - the class of the external nodes being wrapped.
All Implemented Interfaces:
Closeable, AutoCloseable, SequenceIterator<NodeInfo>, AxisIterator, LookaheadIterator<NodeInfo>, UnfailingIterator<NodeInfo>
public class NodeWrappingAxisIterator<B> extends Object implements AxisIterator, LookaheadIterator<NodeInfo>
An AxisIterator that wraps a Java Iterator.

  • Field Details

  • Constructor Details

    • NodeWrappingAxisIterator

      public NodeWrappingAxisIterator(Iterator<? extends B> base, NodeWrappingFunction<? super B,NodeInfo> wrappingFunction)
      Create a SequenceIterator over a given iterator
      Parameters:
      base - the base Iterator
      wrappingFunction - a function that wraps objects of type B in a Saxon NodeInfo

  • Method Details

    • getBaseIterator

      public Iterator<? extends B> getBaseIterator()

    • getNodeWrappingFunction

      public NodeWrappingFunction<? super B,NodeInfo> getNodeWrappingFunction()

    • 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 bit setting SequenceIterator.LOOKAHEAD

      Specified by:
      hasNext in interface LookaheadIterator<B>
      Returns:
      true if there are more items in the sequence

    • 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<B>
      Specified by:
      next in interface UnfailingIterator<B>
      Returns:
      the next Item. If there are no more items, return null.

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

    • isIgnorable

      public boolean isIgnorable(B node)

    • getProperties

      public int getProperties()
      Get properties of this iterator, as a bit-significant integer.
      Specified by:
      getProperties in interface SequenceIterator<B>
      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.