org.eclipse.smila.search.api

Enum QueryConstants.SortOrder

java.lang.Object

java.lang.Enum<QueryConstants.SortOrder>

org.eclipse.smila.search.api.QueryConstants.SortOrder

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<QueryConstants.SortOrder>

Enclosing class:

QueryConstants

public static enum QueryConstants.SortOrder
extends java.lang.Enum<QueryConstants.SortOrder>

Values for the "orderBy"/"mode" parameter: Sort ascending or descending.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCENDING sort ascending.
DESCENDING sort descending.

Method Summary

Methods

Modifier and Type	Method and Description
static QueryConstants.SortOrder	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static QueryConstants.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

ASCENDING

public static final QueryConstants.SortOrder ASCENDING

sort ascending.

DESCENDING

public static final QueryConstants.SortOrder DESCENDING

sort descending.

Method Detail

values

public static QueryConstants.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 (QueryConstants.SortOrder c : QueryConstants.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 QueryConstants.SortOrder 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