net.sf.mmm.util.lang.api

Enum SortOrder

java.lang.Object

java.lang.Enum<SortOrder>

net.sf.mmm.util.lang.api.SortOrder

All Implemented Interfaces:

Serializable, Comparable<SortOrder>, AttributeReadValue<String>, Datatype, SimpleDatatype<String>

public enum SortOrder
extends Enum<SortOrder>
implements SimpleDatatype<String>

This enum contains the possible values for the sort order of a list.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCENDING Indicating that values are in increasing order (e.g.
DESCENDING Indicating that values are in decreasing order (e.g.

Field Summary

Fields

Modifier and Type	Field and Description
private String	title
private String	value

Method Summary

Modifier and Type	Method and Description
int	adjustSignum(int compareTo) Adjusts the Math.signum(double) of a compare to result with this SortOrder to the semantic of Collections.sort(java.util.List, java.util.Comparator).
String	getValue() This method returns the raw value of this datatype.
String	toString() Returns the official String representation of this Datatype.
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.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ASCENDING

public static final SortOrder ASCENDING

Indicating that values are in increasing order (e.g. "1, 2, 3").

DESCENDING

public static final SortOrder DESCENDING

Indicating that values are in decreasing order (e.g. "3, 2, 1").

Field Detail

value

private final String value

See Also:

getValue()

title

private final String title

See Also:

toString()

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 name

NullPointerException - if the argument is null

getValue

public String getValue()

This method returns the raw value of this datatype. This will typically be a standard datatype (like String, Character, Boolean, any type of Number, any type of java.time.LocalDate, etc.).

Specified by:

getValue in interface AttributeReadValue<String>

Specified by:

getValue in interface SimpleDatatype<String>

Returns:

the value of this datatype.

adjustSignum

public int adjustSignum(int compareTo)

Adjusts the Math.signum(double) of a compare to result with this SortOrder to the semantic of Collections.sort(java.util.List, java.util.Comparator). In other words *

Parameters:

compareTo - is the result of a regular compare to operation.

Returns:

the given value (compareTo) for ASCENDING and the negation ( -compareTo) otherwise (for DESCENDING).

toString

public String toString()

Returns the official String representation of this Datatype. While the general contract of Object.toString() is very weak and mainly used for debugging, the contract here is very strong. The returned String has to be suitable for end-users and official output to any kind of sink.
ATTENTION:
This method is not supposed to do internationalization (I18N). See NlsMessage for this purpose and implement NlsObject if you want to support I18N/L10N.

Specified by:

toString in interface Datatype

Overrides:

toString in class Enum<SortOrder>

Returns:

the official String representation to display the value of this Datatype.