Class ManualIterator

    • Constructor Detail

      • ManualIterator

        public ManualIterator()
        Create an uninitialized ManualIterator: this is only usable after the context item, position, and size (if required) have been initialized using setter methods.
      • ManualIterator

        public ManualIterator​(Item value,
                              int position)
        Create a ManualIterator initializing the context item and position. The value of "last()" for such an iterator is unknown unless a LastPositionFinder is supplied.
        value - the context item. May be null if the value is to be initialized later.
        position - the context position
      • ManualIterator

        public ManualIterator​(Item value)
        Create a ManualIterator supplying the context item, and setting the value of both "position()" and "last()" implicitly to 1.
        value - the context item
    • Method Detail

      • setContextItem

        public void setContextItem​(Item value)
      • setLastPositionFinder

        public void setLastPositionFinder​(LastPositionFinder finder)
      • incrementPosition

        public void incrementPosition()
      • setPosition

        public void setPosition​(int position)
      • hasNext

        public boolean hasNext()
        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.
        Specified by:
        hasNext in interface LookaheadIterator
        true if there are more items
      • next

        public Item next()
        Description copied from interface: SequenceIterator
        Get the next item in the sequence. This method changes the state of the iterator.
        Specified by:
        next in interface SequenceIterator
        Specified by:
        next in interface UnfailingIterator
        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.
      • current

        public Item current()
        Description copied from interface: FocusIterator
        Get the current value in the sequence (the one returned by the most recent call on next()). This will be null before the first call of next(). This method does not change the state of the iterator.
        Specified by:
        current in interface FocusIterator
        the current item, the one most recently returned by a call on next(). Returns null if next() has not been called, or if the end of the sequence has been reached.
      • position

        public int position()
        Return the current position in the sequence.
        Specified by:
        position in interface FocusIterator
        0 before the first call on next(); 1 before the second call on next(); -1 after the second call on next().
      • getReverseIterator

        public ManualIterator 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
        Specified by:
        materialize in interface GroundedIterator
        Specified by:
        materialize in interface SequenceIterator
        the corresponding Value. If the value is a closure or a function call package, it will be evaluated and expanded.
      • 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
        the corresponding Value