Package com.apple.foundationdb.tuple

Enum TupleOrdering.Direction

java.lang.Object
java.lang.Enum<TupleOrdering.Direction>
com.apple.foundationdb.tuple.TupleOrdering.Direction
All Implemented Interfaces:
Serializable, Comparable<TupleOrdering.Direction>, java.lang.constant.Constable
Enclosing class:
TupleOrdering
public static enum TupleOrdering.Direction extends Enum<TupleOrdering.Direction>
Direction of ordering. ASC_NULLS_FIRST corresponds to the default Tuple packing and is included for completeness.

  • Enum Constant Details

  • Method Details

    • values

      public static TupleOrdering.Direction[] 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 TupleOrdering.Direction 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

    • isInverted

      public boolean isInverted()
      Get whether the byte ordering is inverted, that is, the opposite of the default unordered byte comparison of packed Tuples.
      Returns:
      true if byte order is inverted

    • isCounterflowNulls

      public boolean isCounterflowNulls()
      Get whether null values sort at the opposite end as in the default Tuple packing.
      Returns:
      true if nulls come at the end when ascending

    • getArrowIndicator

      public String getArrowIndicator()
      Returns a string that symbolizes the meaning of this enum constant.
      Returns:
      the arrow indicator

    • isAscending

      public boolean isAscending()
      Get whether values are ordered ascending. This is the opposite of isInverted(), viewed from the name of the enum, as opposed to what encoding would need to do.
      Returns:
      true if greater values from first

    • isDescending

      public boolean isDescending()
      Get whether values are ordered descending. This is the same as isInverted(), viewed from the name of the enum, as opposed to what encoding would need to do.
      Returns:
      true if greater values from first

    • isNullsFirst

      public boolean isNullsFirst()
      Get whether null values come earlier. This corresponds to the second part of the enum name.
      Returns:
      true if nulls values come before non-null values

    • isNullsLast

      public boolean isNullsLast()
      Get whether null values come later. This corresponds to the second part of the enum name.
      Returns:
      true if nulls values come after non-null values

    • reverseDirection

      @Nonnull public TupleOrdering.Direction reverseDirection()