com.atlassian.query.order
Enum SortOrder

java.lang.Object
  extended by java.lang.Enum<SortOrder>
      extended by com.atlassian.query.order.SortOrder
All Implemented Interfaces:
Serializable, Comparable<SortOrder>

public enum SortOrder
extends Enum<SortOrder>

An enumeration the defines the possible ordering for a Sort.

Since:
4.0

Enum Constant Summary
ASC
          The ascending order.
DESC
          The decending order.
 
Method Summary
static SortOrder parseString(String value)
          Find the SortOrder represented in the passed string.
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, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ASC

public static final SortOrder ASC
The ascending order.


DESC

public static final SortOrder DESC
The decending order.

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

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.


Copyright © 2002-2013 Atlassian. All Rights Reserved.