Class BlockIterator

java.lang.Object
net.sf.saxon.expr.instruct.BlockIterator
All Implemented Interfaces:
Closeable, AutoCloseable, SequenceIterator

public class BlockIterator extends Object implements SequenceIterator
Iterate over the instructions in a sequence of instructions (or an XPath comma expression), concatenating the result of each instruction into a single combined sequence.
  • Constructor Details

  • Method Details

    • next

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