Class PrependSequenceIterator

  • All Implemented Interfaces:, java.lang.AutoCloseable, SequenceIterator
    Direct Known Subclasses:

    public class PrependSequenceIterator
    extends java.lang.Object
    implements SequenceIterator
    An iterator over nodes, that prepends a given node to the nodes returned by another iterator. Used to modify an iterator over axis A to one that iterates over A-OR-SELF.
    • Constructor Detail

    • Method Detail

      • next

        public Item next()
                  throws XPathException
        Get the next item in the sequence.
        Specified by:
        next in interface SequenceIterator
        the next Item. If there are no more items, return null.
        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.lang.AutoCloseable
        Specified by:
        close in interface
        Specified by:
        close in interface SequenceIterator