Package net.sf.saxon.tree.iter

Class ConcatenatingAxisIterator

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, SequenceIterator, AxisIterator
    public class ConcatenatingAxisIterator
extends java.lang.Object
implements AxisIterator
    An iterator over nodes, that concatenates the nodes returned by two supplied iterators.

    • Method Detail

      • next

        public NodeInfo next()
        Get the next item in the sequence.
        Specified by:
        next in interface AxisIterator
        Specified by:
        next in interface SequenceIterator
        Returns:
        the next Item. If there are no more nodes, 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.

        Closing an iterator is not necessary if the iterator is read to completion: if a call on SequenceIterator.next() returns null, the iterator will be closed automatically. An explicit call on SequenceIterator.close() is needed only when iteration is abandoned prematurely.

        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Specified by:
        close in interface SequenceIterator