Package com.treescrub.spedran.requests

Enum SortDirection

java.lang.Object

java.lang.Enum<SortDirection>

com.treescrub.spedran.requests.SortDirection

All Implemented Interfaces:

Serializable, Comparable<SortDirection>

public enum SortDirection
extends Enum<SortDirection>

The sorting direction for requests of collections of resources.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASCENDING	The list will be sorted from the lowest values at the start of the list to the highest at the end of the list.
DESCENDING	The list will be sorted from the highest values at the start of the list to the lowest at the end of the list.

Method Summary

Modifier and Type	Method	Description
String	toParameter()	Gets the SRC API query parameter string.
static SortDirection	valueOf(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 list will be sorted from the lowest values at the start of the list to the highest at the end of the list.

For dates/times, this will sort from oldest to newest.

DESCENDING

public static final SortDirection DESCENDING

The list will be sorted from the highest values at the start of the list to the lowest at the end of the list.

For dates/times, this will sort from newest to oldest.

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 name

NullPointerException - if the argument is null

toParameter

public String toParameter()

Gets the SRC API query parameter string.

Returns:

a String with the query parameter value for use with the SRC API