io.oasp.module.jpa.common.api.to

Enum OrderDirection

java.lang.Object

java.lang.Enum<OrderDirection>

io.oasp.module.jpa.common.api.to.OrderDirection

All Implemented Interfaces:

Serializable, Comparable<OrderDirection>

public enum OrderDirection
extends Enum<OrderDirection>

Enum for sort order.

Author:

jozitz

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASC Sort in ascending order.
DESC Sort in descending order.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isAsc()
boolean	isDesc()
static OrderDirection	valueOf(String name) Returns the enum constant of this type with the specified name.
static 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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ASC

public static final OrderDirection ASC

Sort in ascending order.

DESC

public static final OrderDirection DESC

Sort in descending order.

Method Detail

values

public static 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 (OrderDirection c : 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 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

isAsc

public boolean isAsc()

Returns:

true, if ASC is set. false otherwise.

isDesc

public boolean isDesc()

Returns:

true, if DESC is set. false otherwise.