Enum SortDirection
- java.lang.Object
-
- java.lang.Enum<SortDirection>
-
- africa.absa.inception.core.sorting.SortDirection
-
- All Implemented Interfaces:
Serializable,Comparable<SortDirection>
public enum SortDirection extends Enum<SortDirection>
The SortDirection enumeration defines the possible sort directions when retrieving security related entities.- Author:
- Marcus Portmann
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ASCENDINGSort ascending.DESCENDINGSort descending.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringcode()Returns the code for the sort direction.Stringdescription()Returns the description for the sort direction.static SortDirectionfromCode(String code)Returns the sort direction given by the specified code value.StringtoString()Return the string representation of the sort direction enumeration value.static SortDirectionvalueOf(String name)Returns the enum constant of this type with the specified name.static SortDirection[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ASCENDING
public static final SortDirection ASCENDING
Sort ascending.
-
DESCENDING
public static final SortDirection DESCENDING
Sort descending.
-
-
Method Detail
-
values
public static SortDirection[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (SortDirection c : SortDirection.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SortDirection 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 nameNullPointerException- if the argument is null
-
fromCode
public static SortDirection fromCode(String code)
Returns the sort direction given by the specified code value.- Parameters:
code- the code for the sort direction- Returns:
- the sort direction given by the specified code value
-
code
public String code()
Returns the code for the sort direction.- Returns:
- the code for the sort direction
-
description
public String description()
Returns the description for the sort direction.- Returns:
- the description for the sort direction
-
toString
public String toString()
Return the string representation of the sort direction enumeration value.- Overrides:
toStringin classEnum<SortDirection>- Returns:
- the string representation of the sort direction enumeration value
-
-