Class Remove.RemoveIterator
- All Implemented Interfaces:
Closeable
,AutoCloseable
,LastPositionFinder
,SequenceIterator
- Enclosing class:
Remove
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) SequenceIterator
(package private) int
(package private) Item
(package private) int
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Close the iterator.void
Calling this method instructs the iterator to release any resources it holds, while still remaining able to deliver the remaining items in the sequence.int
Get the last position (that is, the number of items in the sequence).next()
Get the next item in the sequence.boolean
Ask whether this iterator supports use of thegetLength()
method.
-
Field Details
-
base
SequenceIterator base -
removePosition
int removePosition -
basePosition
int basePosition -
current
Item current
-
-
Constructor Details
-
RemoveIterator
-
-
Method Details
-
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 interfaceSequenceIterator
- 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 onSequenceIterator.close()
is needed only when iteration is abandoned prematurely.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceSequenceIterator
-
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 thatSequenceIterator.close()
will be called when no more items are needed.- Specified by:
discharge
in interfaceSequenceIterator
-
supportsGetLength
public boolean supportsGetLength()Ask whether this iterator supports use of thegetLength()
method. This method should always be called before callinggetLength()
, because an iterator that implements this interface may support use ofgetLength()
in some situations and not in others- Specified by:
supportsGetLength
in interfaceLastPositionFinder
- 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 interfaceLastPositionFinder
- Returns:
- the number of items in the sequence
-