Package net.sf.saxon.tree.iter

Class ListIterator.Of<T extends Item>

    • Field Detail

      • list

        protected java.util.List<T extends Item> list

    • Constructor Detail

      • Of

        public Of​(java.util.List<T> list)
        Create a ListIterator over a given List
        Parameters:
        list - the list: all objects in the list must be instances of Item

    • 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 LookaheadIterator.supportsHasNext() is true.

        Returns:
        true if there are more items in the sequence

      • next

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

      • getLength

        public int getLength()
        Description copied from interface: FocusIterator
        Get the position of the last item in the sequence
        Returns:
        the position of the last item

      • 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.
        Returns:
        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()
        Description copied from interface: FocusIterator
        Get the current position. This will usually be zero before the first call on next(), otherwise it will be the number of times that next() has been called. Once next() has returned null, the preferred action is for subsequent calls on position() to return -1, but not all existing implementations follow this practice. (In particular, the EmptyIterator is stateless, and always returns 0 as the value of position(), whether or not next() has been called.)

        This method does not change the state of the iterator.

        Returns:
        the current position, the position of the item returned by the most recent call of next(). This is 1 after next() has been successfully called once, 2 after it has been called twice, and so on. If next() has never been called, the method returns zero. If the end of the sequence has been reached, the value returned will always be <= 0; the preferred value is -1.

      • isActuallyGrounded

        public boolean isActuallyGrounded()
        Description copied from interface: GroundedIterator
        Ask if the iterator is actually grounded. This method must be called before calling GroundedIterator.materialize() or GroundedIterator.getResidue(), because the iterator might be grounded under some conditions and not others (usually when it delegates to another iterator)
        Returns:
        true if this iterator is grounded

      • materialize

        public GroundedValue materialize()
        Return a Sequence containing all the items in the sequence returned by this SequenceIterator
        Returns:
        the corresponding GroundedValue

      • 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).
        Returns:
        the corresponding Value

      • getReverseIterator

        public SequenceIterator 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.
        Returns:
        an iterator over the items in reverse order