Enum SequenceIterator.Property

java.lang.Object
java.lang.Enum<SequenceIterator.Property>
net.sf.saxon.om.SequenceIterator.Property
All Implemented Interfaces:
Serializable, Comparable<SequenceIterator.Property>, java.lang.constant.Constable
Enclosing interface:
SequenceIterator

public static enum SequenceIterator.Property extends Enum<SequenceIterator.Property>
  • Enum Constant Details

    • GROUNDED

      public static final SequenceIterator.Property GROUNDED
      Property value: the iterator is "grounded". This means that (a) the iterator must be an instance of GroundedIterator, and (b) the implementation of the materialize() method must be efficient (in particular, it should not involve the creation of new objects)
    • LAST_POSITION_FINDER

      public static final SequenceIterator.Property LAST_POSITION_FINDER
      Property value: the iterator knows the number of items that it will deliver. This means that (a) the iterator must be an instance of LastPositionFinder, and (b) the implementation of the getLastPosition() method must be efficient (in particular, it should take constant time, rather than time proportional to the length of the sequence)
    • LOOKAHEAD

      public static final SequenceIterator.Property LOOKAHEAD
      Property value: the iterator knows whether there are more items still to come. This means that (a) the iterator must be an instance of LookaheadIterator, and (b) the implementation of the hasNext() method must be efficient (more efficient than the client doing it)
    • ATOMIZING

      public static final SequenceIterator.Property ATOMIZING
      Property value: the iterator can deliver an atomized result. This means that the iterator must be an instance of AtomizingIterator.
  • Method Details

    • values

      public static SequenceIterator.Property[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static SequenceIterator.Property valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null