Package com.atlassian.query.order

Enum Class SortOrder

java.lang.Object

java.lang.Enum<SortOrder>

com.atlassian.query.order.SortOrder

All Implemented Interfaces:

Serializable, Comparable<SortOrder>, Constable

public enum SortOrder
extends Enum<SortOrder>

An enumeration the defines the possible ordering for a Sort.

Since:

4.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASC	The ascending order.
DESC	The descending order.

Method Summary

Modifier and Type	Method	Description
static SortOrder	parseString(String value)	Find the SortOrder represented in the passed string.
static SortOrder	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SortOrder[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ASC

public static final SortOrder ASC

The ascending order.

DESC

public static final SortOrder DESC

The descending order.

Method Details

values

public static SortOrder[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SortOrder valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

parseString

public static SortOrder parseString(String value)

Find the SortOrder represented in the passed string. The matching is based on the names of the value in the enumeration. All matching is done in a case insensitive manner. The order ASC will be returned if no match is found.

Parameters:

value - the string to parse.

Returns:

the parsed SortOrder.