public class ReturnClauseIterator extends java.lang.Object implements SequenceIterator
|Constructor and Description|
Construct an iterator over the results of the FLWOR expression.
|Modifier and Type||Method and Description|
Close the iterator.
Calling this method instructs the iterator to release any resources it holds, while still remaining able to deliver the remaining items in the sequence.
Get the next item in the sequence.
public Item next()
public void close()
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
SequenceIterator.next() returns null, the iterator will be closed automatically. An explicit
SequenceIterator.close() is needed only when iteration is abandoned prematurely.
public void discharge()
SequenceIterator.close()will be called when no more items are needed.
Copyright (c) 2004-2022 Saxonica Limited. All rights reserved.