com.canto.cumulus.constants

Enum SortDirection

java.lang.Object

java.lang.Enum<SortDirection>

com.canto.cumulus.constants.SortDirection

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SortDirection>

public enum SortDirection
extends java.lang.Enum<SortDirection>

This enum specifies the available sort directions for sorting a collection.

Since:

8.0

See Also:

ItemCollection.setSortDirection(SortDirection), MultiItemCollection.setSortDirection(SortDirection)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCENDING The collection is sorted ascending.
DESCENDING The collection is sorted descending.

Method Summary

Methods

Modifier and Type	Method and Description
static SortDirection	find(int id) Finds the sort direction for the given id.
static SortDirection	find(java.lang.String name) Finds the sort direction for the given name which needs to be a textual representation of the enum name.
int	getID() Returns the id for this sort direction.
static SortDirection	valueOf(java.lang.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.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ASCENDING

public static final SortDirection ASCENDING

The collection is sorted ascending.

DESCENDING

public static final SortDirection DESCENDING

The collection is sorted 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(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

getID

public int getID()

Returns the id for this sort direction.

Returns:

id

find

public static SortDirection find(int id)

Finds the sort direction for the given id.

Parameters:

id - wanted id

Returns:

found sort direction or throws an EnumConstantNotPresentException if the id could not be found

find

public static SortDirection find(java.lang.String name)

Finds the sort direction for the given name which needs to be a textual representation of the enum name.

Parameters:

name - wanted direction, ie. ascending or descending

Returns:

found sort direction or throws an EnumConstantNotPresentException if the name could not be found

Since:

8.1