Class Remove.RemoveIterator

java.lang.Object
net.sf.saxon.functions.Remove.RemoveIterator
All Implemented Interfaces:
Closeable, AutoCloseable, LastPositionFinder, SequenceIterator
Enclosing class:
Remove
public static class Remove.RemoveIterator extends Object implements SequenceIterator, LastPositionFinder
An implementation of SequenceIterator that returns all items except the one at a specified position.

  • Field Details

    • base

      SequenceIterator base

    • removePosition

      int removePosition

    • basePosition

      int basePosition

    • current

      Item current

  • Constructor Details

    • RemoveIterator

      public RemoveIterator(SequenceIterator base, int removePosition)

  • Method Details

    • next

      public Item next()
      Description copied from interface: SequenceIterator
      Get the next item in the sequence. This method changes the state of the iterator.
      Specified by:
      next in interface SequenceIterator
      Returns:
      the next item, or null if there are no more items. Once a call on next() has returned null, no further calls should be made. The preferred action for an iterator if subsequent calls on next() are made is to return null again, and all implementations within Saxon follow this rule.

    • 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 AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in interface SequenceIterator

    • discharge

      public void discharge()
      Description copied from interface: SequenceIterator
      Calling this method instructs the iterator to release any resources it holds, while still remaining able to deliver the remaining items in the sequence. This may require the iterator to calculate the rest of the sequence eagerly. The method is called by a client if it anticipates that it might not read the iterator to completion, but it cannot guarantee that SequenceIterator.close() will be called when no more items are needed.
      Specified by:
      discharge in interface SequenceIterator

    • supportsGetLength

      public boolean supportsGetLength()
      Ask whether this iterator supports use of the getLength() method. This method should always be called before calling getLength(), because an iterator that implements this interface may support use of getLength() in some situations and not in others
      Specified by:
      supportsGetLength in interface LastPositionFinder
      Returns:
      true if the getLength() method can be called to determine the length of the underlying sequence.

    • getLength

      public int getLength()
      Get the last position (that is, the number of items in the sequence). This method is non-destructive: it does not change the state of the iterator. The result is undefined if the next() method of the iterator has already returned null.
      Specified by:
      getLength in interface LastPositionFinder
      Returns:
      the number of items in the sequence