Package com.helger.base.compare

Enum Class ESortOrder

java.lang.Object
java.lang.Enum<ESortOrder>
com.helger.base.compare.ESortOrder
All Implemented Interfaces:
ISortOrderIndicator, Serializable, Comparable<ESortOrder>, Constable
public enum ESortOrder extends Enum<ESortOrder> implements ISortOrderIndicator
Defines possible sort orders. The default is ASCENDING sorting.
Author:
Philip Helger

  • Enum Constant Details

    • ASCENDING

      public static final ESortOrder ASCENDING

    • DESCENDING

      public static final ESortOrder DESCENDING

  • Field Details

  • Method Details

    • values

      public static ESortOrder[] 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 ESortOrder 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

    • getValue

      @Nonnegative public int getValue()
      Returns:
      The associated value for this sort order. The value can directly be used in compare methods to multiply the initial return value with this value to have the correct ordering.

    • getValueAsString

      public @NonNull String getValueAsString()
      Returns:
      The value as a String representation. Never null.

    • isAscending

      public boolean isAscending()
      Specified by:
      isAscending in interface ISortOrderIndicator
      Returns:
      true is ascending sort order is active.

    • getAlternate

      public @NonNull ESortOrder getAlternate()
      Get the alternate sort order. If the current sort order is ascending, the result will be descending and if this is descending, the return will be ascending.
      Returns:
      Never null.

    • getFromValueOrDefault

      public static @NonNull ESortOrder getFromValueOrDefault(int nValue)
      Get the ESortOrder matching the provided value, defaulting to DEFAULT.
      Parameters:
      nValue - The value to search for.
      Returns:
      Never null.

    • getFromValue

      public static @Nullable ESortOrder getFromValue(int nValue, @Nullable ESortOrder eDefault)
      Get the ESortOrder matching the provided value, with a custom default.
      Parameters:
      nValue - The value to search for.
      eDefault - The default value to return if no match is found. May be null.
      Returns:
      The matching enum value or the provided default.