- java.lang.Object
-
- java.lang.Enum<SortOrder>
-
- io.github.mmm.base.sort.SortOrder
-
- All Implemented Interfaces:
Serializable
,Comparable<SortOrder>
public enum SortOrder extends Enum<SortOrder>
This enum contains the possible values for the sort order.- Since:
- 1.0.0
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ASCENDING
Indicating that values are in increasing order (e.g.DESCENDING
Indicating that values are in decreasing order (e.g.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
adjustSignum(int compareTo)
Adjusts theMath.signum(double)
of acompare to
result with thisSortOrder
to the semantic ofCollections.sort(java.util.List, java.util.Comparator)
.String
getValue()
String
toString()
static SortOrder
valueOf(String name)
Returns the enum constant of this type with the specified name.static SortOrder[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Method Detail
-
values
public static SortOrder[] 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 (SortOrder c : SortOrder.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SortOrder 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
-
adjustSignum
public int adjustSignum(int compareTo)
Adjusts theMath.signum(double)
of acompare to
result with thisSortOrder
to the semantic ofCollections.sort(java.util.List, java.util.Comparator)
. In other words *- Parameters:
compareTo
- is the result of a regularcompare to
operation.- Returns:
- the given value (
compareTo
) forASCENDING
and the negation (-compareTo
) otherwise (forDESCENDING
).
-
-