com.sdl.web.api.broker.querying.sorting

Enum SortDirection

java.lang.Object

java.lang.Enum<SortDirection>

com.sdl.web.api.broker.querying.sorting.SortDirection

All Implemented Interfaces:

BrokerSortDirection, Serializable, Comparable<SortDirection>

public enum SortDirection
extends Enum<SortDirection>
implements BrokerSortDirection

This represents the sorting direction which can be used in sorting the Broker results.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCENDING Ascending operator.
DESCENDING Descending operator.

Method Summary

Modifier and Type	Method and Description
String	getSQLSortDirection() Returns SQL sort direction String representation.
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

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 SortDirection ASCENDING

Ascending operator.

DESCENDING

public static final SortDirection DESCENDING

Descending operator.

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

getSQLSortDirection

public String getSQLSortDirection()

Description copied from interface: BrokerSortDirection

Returns SQL sort direction String representation.

Specified by:

getSQLSortDirection in interface BrokerSortDirection

Returns:

SQL sort direction String representation