Class PrependIterator

java.lang.Object
net.sf.saxon.om.PrependIterator
All Implemented Interfaces:
AxisIterator, SequenceIterator

public class PrependIterator extends Object implements AxisIterator
An iterator over nodes, that prepends a given node to the nodes returned by another iterator. Used to modify an iterator over axis A to one that iterates over A-OR-SELF.
  • Field Details

  • Constructor Details

  • Method Details

    • next

      public Item next()
      Get the next item in the sequence.
      Specified by:
      next in interface AxisIterator
      Specified by:
      next in interface SequenceIterator
      Returns:
      the next Item. If there are no more nodes, return null.
    • current

      public Item current()
      Get the current item in the sequence.
      Specified by:
      current in interface AxisIterator
      Specified by:
      current in interface SequenceIterator
      Returns:
      the current item, that is, the item most recently returned by next()
    • position

      public int position()
      Get the current position
      Specified by:
      position in interface AxisIterator
      Specified by:
      position in interface SequenceIterator
      Returns:
      the position of the current item (the item most recently returned by next()), starting at 1 for the first node
    • getAnother

      public SequenceIterator getAnother()
      Get another iterator over the same sequence of items, positioned at the start of the sequence
      Specified by:
      getAnother in interface AxisIterator
      Specified by:
      getAnother in interface SequenceIterator
      Returns:
      a new iterator over the same sequence
    • getProperties

      public int 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.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.