com.jivesoftware.community
Enum SearchQueryCriteria.SortOrder

java.lang.Object
  java.lang.Enum<SearchQueryCriteria.SortOrder>
      com.jivesoftware.community.SearchQueryCriteria.SortOrder

All Implemented Interfaces:

Serializable, Comparable<SearchQueryCriteria.SortOrder>

Enclosing interface:

SearchQueryCriteria

public static enum SearchQueryCriteria.SortOrder
extends Enum<SearchQueryCriteria.SortOrder>

Represents the order in which search results will be returned

Enum Constant Summary

ASCENDING
Ascending sort (ie 3, 4, 5...).

DESCENDING
Descending sort (ie 3, 2, 1...).

Method Summary

int	getKey()
static SearchQueryCriteria.SortOrder	getSortOrder(int key) A helper method to get a specific SortOrder object from its key
static SearchQueryCriteria.SortOrder	valueOf(String name) Returns the enum constant of this type with the specified name.
static SearchQueryCriteria.SortOrder[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DESCENDING

public static final SearchQueryCriteria.SortOrder DESCENDING

Descending sort (ie 3, 2, 1...).

ASCENDING

public static final SearchQueryCriteria.SortOrder ASCENDING

Ascending sort (ie 3, 4, 5...).

Method Detail

values

public static final SearchQueryCriteria.SortOrder[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(SearchQueryCriteria.SortOrder c : SearchQueryCriteria.SortOrder.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static SearchQueryCriteria.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

getKey

public int getKey()

getSortOrder

public static SearchQueryCriteria.SortOrder getSortOrder(int key)

A helper method to get a specific SortOrder object from its key

Parameters:

key - the key value of the SortOrder object

Returns:

the SortOrder object corresponding to the key value. NULL if the key is invalid.