net.sf.saxon.om

Interface SequenceIterator

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Subinterfaces:

AtomicIterator, AtomizedValueIterator, AxisIterator, FocusIterator, GroundedIterator, GroupIterator, LookaheadIterator, RegexIterator, ReversibleIterator

All Known Implementing Classes:

AbstractBlockIterator, AdjacentTextNodeMergingIterator, AncestorIterator, ARegexIterator, ArrayIterator, ArrayIterator.Of, ArrayIterator.OfNodes, AscendingRangeIterator, ATokenIterator, AtomizingIterator, AttributeIterator, AxiomDocument.FollowingSiblingIterator, AxiomDocument.PrecedingSiblingIterator, AxiomDocumentNodeWrapper.FollowingSiblingIterator, AxiomDocumentNodeWrapper.PrecedingSiblingIterator, AxiomParentNodeWrapper.ChildWrappingIterator, AxiomParentNodeWrapper.DescendantWrappingIterator, AxisAtomizingIterator, BigRangeIterator, BlockIterator, CardinalityCheckingIterator, CodepointIterator, CompiledBlockIterator, CompiledFilterIterator, ConcatenatingAxisIterator, ContextMappingIterator, DescendingRangeIterator, DifferenceEnumeration, DistinctValues.DistinctIterator, DocumentOrderIterator, EmptyIterator, ErrorIterator, FilterIterator, FilterIterator.NonNumeric, FocusTrackingIterator, GroupAdjacentIterator, GroupBreakingIterator, GroupByIterator, GroupByIterator.ManualGroupByIterator, GroupEndingIterator, GroupMatchingIterator, GroupStartingIterator, HomogeneityCheckerIterator, InsertBefore.InsertIterator, IntersectionEnumeration, ItemCheckingIterator, ItemMappingIterator, IteratorWrapper, JRegexIterator, JTokenIterator, ListIterator, ListIterator.Of, ListIterator.OfAtomic, LookaheadIteratorImpl, ManualGroupIterator, ManualIterator, ManualRegexIterator, MappingIterator, MemoSequence.ProgressiveIterator, MergeGroupingIterator, MergeGroupingIterator.ManualMergeGroupingIterator, MergeIterator, MultiIndex.SelectedItemsIterator, MultithreadedContextMappingIterator, MultithreadedFocusTrackingIterator, MultithreadedItemMappingIterator, Navigator.AncestorEnumeration, Navigator.AxisFilter, Navigator.DescendantEnumeration, Navigator.EmptyTextFilter, Navigator.FollowingEnumeration, Navigator.PrecedingEnumeration, NodeListIterator, NodeWrappingAxisIterator, OneToOneMappingIterator, PrependAxisIterator, PrependSequenceIterator, RangeIterator, net.sf.saxon.expr.RangeIterator, Remove.RemoveIterator, ReturnClauseIterator, Reverse.ReverseListIterator, SequenceIteratorOverJavaIterator, SingleAtomicIterator, SingleNodeIterator, SingletonIterator, SortedGroupIterator, SortedIterator, SteppingNavigator.DescendantAxisIterator, StringValue.CharacterIterator, SubsequenceIterator, TailIterator, TextLinesIterator, TwoItemIterator, UnionEnumeration, UnionIterator, UnparsedTextIterator, UntypedAtomizingIterator, ValueTailIterator, VirtualCopy.VirtualCopier, Whitespace.Tokenizer, WrappingIterator, ZenoSequence.ZenoSequenceIterator

public interface SequenceIterator
extends java.io.Closeable

A SequenceIterator is used to iterate over any XPath 2 sequence (of values or nodes). To get the next item in a sequence, call next(); if this returns null, you've reached the end of the sequence.

The objects returned by the SequenceIterator will generally be either nodes (class NodeInfo), singleton values (class AtomicValue), or function items: these are represented collectively by the interface Item.

The interface to SequenceIterator is changed in Saxon 9.6 to drop support for the current() and position() methods. Internal iterators no longer need to maintain the values of the current item or the current position. This information is needed (in general) only for an iterator that acts as the current focus; that is, an iterator stored as the current iterator in an XPathContext. SequenceIterators than maintain the value of position() and last() are represented by the interface FocusIterator.

Since:

8.4. Significant changes in 9.6. Generics added in 9.9, removed again in 10.0. getProperties() method dropped in 11 (instead, callers should check whether the iterator implements a more specific interface such as LastPositionFinder)

Method Summary

Modifier and Type	Method and Description
default void	close() Close the iterator.
default void	discharge() Calling this method instructs the iterator to release any resources it holds, while still remaining able to deliver the remaining items in the sequence.
Item	next() Get the next item in the sequence.

Method Detail

next

Item next()

Get the next item in the sequence. This method changes the state of the iterator.

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.

Throws:

UncheckedXPathException - if an error occurs retrieving the next item

Since:

8.4. Changed in 11 so it no longer throws a checked exception; instead, any error that occurs is thrown as an unchecked exception.

close

default void close()

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 next() returns null, the iterator will be closed automatically. An explicit call on 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

Since:

9.1. Default implementation added in 9.9.

discharge

default void discharge()

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 close() will be called when no more items are needed.

Since:

11.1