Package net.sf.saxon.expr
Class BigRangeIterator
java.lang.Object
net.sf.saxon.expr.BigRangeIterator
- All Implemented Interfaces:
Closeable,AutoCloseable,LastPositionFinder,SequenceIterator,AtomicIterator<IntegerValue>,LookaheadIterator,UnfailingIterator
public class BigRangeIterator
extends Object
implements AtomicIterator<IntegerValue>, LastPositionFinder, LookaheadIterator
An Iterator that produces numeric values in a monotonic sequence,
where the integers may exceed the range of a Long
-
Nested Class Summary
Nested classes/interfaces inherited from interface net.sf.saxon.om.SequenceIterator
SequenceIterator.Property -
Field Summary
FieldsModifier and TypeFieldDescription(package private) BigInteger(package private) BigInteger(package private) BigInteger -
Constructor Summary
ConstructorsConstructorDescriptionBigRangeIterator(BigInteger start, BigInteger end) Create an iterator over a range of monotonically increasing integers -
Method Summary
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface net.sf.saxon.om.SequenceIterator
close, forEachOrFail, materializeMethods inherited from interface net.sf.saxon.tree.iter.UnfailingIterator
forEach, toList
-
Field Details
-
start
BigInteger start -
currentValue
BigInteger currentValue -
limit
BigInteger limit
-
-
Constructor Details
-
BigRangeIterator
Create an iterator over a range of monotonically increasing integers- Parameters:
start- the first integer in the sequenceend- the last integer in the sequence. Must be >= start.- Throws:
XPathException- if for example the end is before the start
-
-
Method Details
-
hasNext
public boolean hasNext()Description copied from interface:LookaheadIteratorDetermine whether there are more items to come. Note that this operation is stateless and it is not necessary (or usual) to call it before calling next(). It is used only when there is an explicit need to tell if we are at the last element.This method must not be called unless the result of getProperties() on the iterator includes the property
SequenceIterator.Property.LOOKAHEAD- Specified by:
hasNextin interfaceLookaheadIterator- Returns:
- true if there are more items in the sequence
-
next
Description copied from interface:AtomicIteratorGet the next atomic value in the sequence.- Specified by:
nextin interfaceAtomicIterator<IntegerValue>- Specified by:
nextin interfaceSequenceIterator- Specified by:
nextin interfaceUnfailingIterator- Returns:
- the next Item. If there are no more items, return null.
-
getLength
public int getLength()Description copied from interface:LastPositionFinderGet 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. This method must not be called unless the result of getProperties() on the iterator includes the bit settingSequenceIterator.Property.LAST_POSITION_FINDER- Specified by:
getLengthin interfaceLastPositionFinder- Returns:
- the number of items in the sequence
-
getProperties
Get properties of this iterator, as a bit-significant integer.- Specified by:
getPropertiesin interfaceSequenceIterator- Returns:
- the properties of this iterator. This will be some combination of
properties such as
SequenceIterator.Property.GROUNDED,SequenceIterator.Property.LAST_POSITION_FINDER, andSequenceIterator.Property.LOOKAHEAD. It is always acceptable to return the value zero, indicating that there are no known special properties. It is acceptable for the properties of the iterator to change depending on its state.
-