com.communote.server.core.vo.query

Enum QueryParameters.OrderDirection

java.lang.Object

java.lang.Enum<QueryParameters.OrderDirection>

com.communote.server.core.vo.query.QueryParameters.OrderDirection

All Implemented Interfaces:

Serializable, Comparable<QueryParameters.OrderDirection>

Enclosing class:

QueryParameters

public static enum QueryParameters.OrderDirection
extends Enum<QueryParameters.OrderDirection>

Enum for possible orderings in "ORDER BY" clauses.

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method and Description
static String	appendOrderBy(String orderBy, String field, QueryParameters.OrderDirection orderDirection) Method to append the given orderBy clause with the new ordering.
String	toString()
static QueryParameters.OrderDirection	valueOf(String name) Returns the enum constant of this type with the specified name.
static QueryParameters.OrderDirection[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ASCENDING

public static final QueryParameters.OrderDirection ASCENDING

Ascending order.

DESCENDING

public static final QueryParameters.OrderDirection DESCENDING

Descending order.

Method Detail

values

public static QueryParameters.OrderDirection[] 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 (QueryParameters.OrderDirection c : QueryParameters.OrderDirection.values())
    System.out.println(c);

Returns:

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

valueOf

public static QueryParameters.OrderDirection 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

appendOrderBy

public static String appendOrderBy(String orderBy,
                                   String field,
                                   QueryParameters.OrderDirection orderDirection)

Method to append the given orderBy clause with the new ordering.

Parameters:

orderBy - The current orderBy clause

field - The field to order.

orderDirection - The direction to order in. If this is null, the method will return without doing anything.

Returns:

The new orderBy clause.

toString

public String toString()

Overrides:

toString in class Enum<QueryParameters.OrderDirection>

Returns:

A value, which can directly be rendered into the order by clause.