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

Fields

Modifier and Type	Field	Description
(package private) BigInteger	currentValue
(package private) BigInteger	limit
(package private) BigInteger	start

Constructor Summary

Constructors

Constructor	Description
BigRangeIterator(BigInteger start, BigInteger end)	Create an iterator over a range of monotonically increasing integers

Method Summary

Modifier and Type	Method	Description
int	getLength()	Get the last position (that is, the number of items in the sequence).
EnumSet<SequenceIterator.Property>	getProperties()	Get properties of this iterator, as a bit-significant integer.
boolean	hasNext()	Determine whether there are more items to come.
IntegerValue	next()	Get the next atomic value in the sequence.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.saxon.om.SequenceIterator

close, forEachOrFail, materialize

Methods inherited from interface net.sf.saxon.tree.iter.UnfailingIterator

forEach, toList

Field Detail

start

BigInteger start

currentValue

BigInteger currentValue

limit

BigInteger limit

Constructor Detail

BigRangeIterator

public BigRangeIterator(BigInteger start,
                        BigInteger end)
                 throws XPathException

Create an iterator over a range of monotonically increasing integers

Parameters:

start - the first integer in the sequence

end - the last integer in the sequence. Must be >= start.

Throws:

XPathException - if for example the end is before the start

Method Detail

hasNext

public boolean hasNext()

Description copied from interface: LookaheadIterator

Determine 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:

hasNext in interface LookaheadIterator

Returns:

true if there are more items in the sequence

next

public IntegerValue next()

Description copied from interface: AtomicIterator

Get the next atomic value in the sequence.

Specified by:

next in interface AtomicIterator<IntegerValue>

Specified by:

next in interface SequenceIterator

Specified by:

next in interface UnfailingIterator

Returns:

the next Item. If there are no more items, return null.

getLength

public int getLength()

Description copied from interface: LastPositionFinder

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. This method must not be called unless the result of getProperties() on the iterator includes the bit setting SequenceIterator.Property.LAST_POSITION_FINDER

Specified by:

getLength in interface LastPositionFinder

Returns:

the number of items in the sequence

getProperties

public EnumSet<SequenceIterator.Property> getProperties()

Get properties of this iterator, as a bit-significant integer.

Specified by:

getProperties in interface SequenceIterator

Returns:

the properties of this iterator. This will be some combination of properties such as SequenceIterator.Property.GROUNDED, SequenceIterator.Property.LAST_POSITION_FINDER, and SequenceIterator.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.