public class RangeIterator extends java.lang.Object implements AtomicIterator, ReversibleIterator, LastPositionFinder, LookaheadIterator, GroundedIterator
ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
Constructor and Description |
---|
RangeIterator(long start,
long end)
Create an iterator over a range of monotonically increasing integers
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the iterator.
|
int |
getLength()
Get the last position (that is, the number of items in the sequence).
|
int |
getProperties()
Get properties of this iterator, as a bit-significant integer.
|
GroundedValue |
getResidue()
Return a GroundedValue containing all the remaining items in the sequence returned by this
SequenceIterator, starting at the current position.
|
SequenceIterator |
getReverseIterator()
Get a new SequenceIterator that returns the same items in reverse order.
|
boolean |
hasNext()
Determine whether there are more items to come.
|
static SequenceIterator |
makeRangeIterator(IntegerValue start,
IntegerValue end) |
GroundedValue |
materialize()
Return a Value containing all the items in the sequence returned by this
SequenceIterator.
|
IntegerValue |
next()
Get the next item in the sequence.
|
public RangeIterator(long start, long end)
start
- the first integer in the sequenceend
- the last integer in the sequence. Must be >= start.public static SequenceIterator makeRangeIterator(IntegerValue start, IntegerValue end) throws XPathException
XPathException
public boolean hasNext()
LookaheadIterator
SequenceIterator.LOOKAHEAD
hasNext
in interface LookaheadIterator
public IntegerValue next()
AtomicIterator
next
in interface SequenceIterator
next
in interface AtomicIterator
next
in interface UnfailingIterator
public void close()
SequenceIterator
(Currently, closing an iterator is important only 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.)
close
in interface SequenceIterator
public int getLength()
LastPositionFinder
SequenceIterator.LAST_POSITION_FINDER
getLength
in interface LastPositionFinder
public int getProperties()
getProperties
in interface SequenceIterator
SequenceIterator.GROUNDED
, SequenceIterator.LAST_POSITION_FINDER
,
and SequenceIterator.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.public SequenceIterator getReverseIterator()
ReversibleIterator
getReverseIterator
in interface ReversibleIterator
public GroundedValue materialize()
materialize
in interface GroundedIterator
public GroundedValue getResidue() throws XPathException
GroundedIterator
getResidue
in interface GroundedIterator
XPathException
- in the cases of subclasses (such as the iterator over a MemoClosure)
which cause evaluation of expressions while materializing the value.Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.