Class AscendingRangeIterator

    • Constructor Detail

      • AscendingRangeIterator

        public AscendingRangeIterator​(long start,
                                      long step,
                                      long end)
        Create an iterator over a range of monotonically increasing integers
        start - the first integer in the sequence
        step - the increment; must be GT 0
        end - the last integer in the sequence. Must be GE start.
    • Method Detail

      • getStep

        public IntegerValue getStep()
        Get the increment between successive values. For a descending iterator this will be negatiive value.
        the increment between successive values
      • supportsHasNext

        public boolean supportsHasNext()
        Description copied from interface: LookaheadIterator
        Ask whether the hasNext() method can be called. This method must be called before calling hasNext(), because some iterators implement this interface, but only support look-ahead under particular circumstances (this is usually because they delegate to another iterator)
        Specified by:
        supportsHasNext in interface LookaheadIterator
        true if the LookaheadIterator.hasNext() method is available
      • 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 LookaheadIterator.supportsHasNext() is true.

        Specified by:
        hasNext in interface LookaheadIterator
        hasNext in class net.sf.saxon.expr.RangeIterator
        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
        Specified by:
        next in interface SequenceIterator
        next in class net.sf.saxon.expr.RangeIterator
        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 LastPositionFinder.supportsGetLength() has been called and has returned true.
        Specified by:
        getLength in interface LastPositionFinder
        getLength in class net.sf.saxon.expr.RangeIterator
        the number of items in the sequence
      • getReverseIterator

        public AtomicIterator getReverseIterator()
        Description copied from interface: ReversibleIterator
        Get a new SequenceIterator that returns the same items in reverse order. If this SequenceIterator is an AxisIterator, then the returned SequenceIterator must also be an AxisIterator.
        Specified by:
        getReverseIterator in interface ReversibleIterator
        an iterator over the items in reverse order
      • materialize

        public GroundedValue materialize()
        Return a Value containing all the items in the sequence returned by this SequenceIterator. This should be an "in-memory" value, not a Closure.
        Specified by:
        materialize in interface GroundedIterator
        materialize in class net.sf.saxon.expr.RangeIterator
        the corresponding Value
      • getResidue

        public GroundedValue getResidue()
        Description copied from interface: GroundedIterator
        Return a GroundedValue containing all the remaining items in the sequence returned by this SequenceIterator, starting at the current position. This should be an "in-memory" value, not a Closure. This method does not change the state of the iterator (in particular, it does not consume the iterator).
        Specified by:
        getResidue in interface GroundedIterator
        getResidue in class net.sf.saxon.expr.RangeIterator
        the corresponding Value