Package net.sf.saxon.tree.iter

Class SingleAtomicIterator

java.lang.Object
net.sf.saxon.tree.iter.SingletonIterator
net.sf.saxon.tree.iter.SingleAtomicIterator
All Implemented Interfaces:
Closeable, AutoCloseable, LastPositionFinder, FocusIterator, SequenceIterator, AtomicIterator, GroundedIterator, LookaheadIterator, ReversibleIterator
public class SingleAtomicIterator extends SingletonIterator implements AtomicIterator, ReversibleIterator, LastPositionFinder, GroundedIterator, LookaheadIterator
SingletonIterator: an iterator over a sequence of exactly one atomic value

  • Constructor Details

    • SingleAtomicIterator

      protected SingleAtomicIterator(AtomicValue value)
      Protected constructor: external classes should use the factory method
      Parameters:
      value - the item to iterate over

  • Method Details

    • makeIterator

      public static AtomicIterator makeIterator(AtomicValue item)
      Factory method.
      Parameters:
      item - the item to iterate over
      Returns:
      a SingletonIterator over the supplied item, or an EmptyIterator if the supplied item is null.

    • getReverseIterator

      public SingleAtomicIterator 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
      Overrides:
      getReverseIterator in class SingletonIterator
      Returns:
      an iterator over the items in reverse order

    • next

      public AtomicValue 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 AtomicIterator
      Specified by:
      next in interface SequenceIterator
      Overrides:
      next in class SingletonIterator
      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.