Enum Class Sort.Direction

java.lang.Object
java.lang.Enum<Sort.Direction>
org.springframework.data.domain.Sort.Direction
All Implemented Interfaces:
Serializable, Comparable<Sort.Direction>, Constable
Enclosing class:
Sort

public static enum Sort.Direction extends Enum<Sort.Direction>
Enumeration for sort directions.
Author:
Oliver Gierke
  • Enum Constant Details

  • Method Details

    • values

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

      public static Sort.Direction valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null
    • isAscending

      public boolean isAscending()
      Returns whether the direction is ascending.
      Returns:
      true if ascending, false otherwise.
      Since:
      1.13
    • isDescending

      public boolean isDescending()
      Returns whether the direction is descending.
      Returns:
      true if descending, false otherwise.
      Since:
      1.13
    • fromString

      public static Sort.Direction fromString(String value)
      Returns the Sort.Direction enum for the given String value.
      Parameters:
      value - the direction name.
      Returns:
      the Sort.Direction enum value for the given value.
      Throws:
      IllegalArgumentException - in case the given value cannot be parsed into an enum value.
    • fromOptionalString

      public static Optional<Sort.Direction> fromOptionalString(String value)
      Returns the Sort.Direction enum for the given String or Optional.empty() if it cannot be parsed into an enum value.
      Parameters:
      value - the direction name.
      Returns:
      Optional holding the Sort.Direction enum value or empty, if value cannot be parsed into Sort.Direction.