Package de.digitalcollections.model.api.paging.enums

Enum Direction

java.lang.Object
java.lang.Enum<Direction>
de.digitalcollections.model.api.paging.enums.Direction
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Direction>, java.lang.constant.Constable
public enum Direction
extends java.lang.Enum<Direction>
Enumeration for sort directions. See Spring Data Commons, but more flat design and independent of Spring libraries.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant Description
    ASC  
    DESC  

  • Method Summary

    Modifier and Type Method Description
    static Direction fromString​(java.lang.String value)
    Returns the Direction enum for the given String value.
    static Direction fromStringOrNull​(java.lang.String value)
    Returns the Direction enum for the given String or null if it cannot be parsed into an enum value.
    boolean isAscending()  
    boolean isDescending()  
    static Direction valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static Direction[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

  • Method Details

    • values

      public static 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 Direction valueOf​(java.lang.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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null

    • isAscending

      public boolean isAscending()
      Returns:
      true if direction is ascending

    • isDescending

      public boolean isDescending()
      Returns:
      true if direction is ascending

    • fromString

      public static Direction fromString​(java.lang.String value)
      Returns the Direction enum for the given String value.
      Parameters:
      value - given direction value
      Returns:
      the direction enumeration
      Throws:
      java.lang.IllegalArgumentException - in case the given value cannot be parsed into an enum value.

    • fromStringOrNull

      public static Direction fromStringOrNull​(java.lang.String value)
      Returns the Direction enum for the given String or null if it cannot be parsed into an enum value.
      Parameters:
      value - given direction value
      Returns:
      the appropriate direction enum or null