de.digitalcollections.core.model.api.paging.enums

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

de.digitalcollections.core.model.api.paging.enums.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>

public enum Direction
extends Enum<Direction>

Enumeration for sort directions. See Spring Data Commons, but more flat design and independent of Spring libraries.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASC
DESC

Method Summary

Modifier and Type	Method and Description
static Direction	fromString(String value) Returns the Direction enum for the given String value.
static Direction	fromStringOrNull(String value) Returns the Direction enum for the given String or null if it cannot be parsed into an enum value.
boolean	isAscending()
boolean	isDescending()
static Direction	valueOf(String name) Returns the enum constant of this type with the specified name.
static Direction[]	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 Direction ASC

DESC

public static final Direction DESC

Method Detail

values

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

Returns:

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

valueOf

public static Direction 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

isAscending

public boolean isAscending()

Returns:

true if direction is ascending

isDescending

public boolean isDescending()

Returns:

true if direction is ascending

fromString

public static Direction fromString(String value)

Returns the Direction enum for the given String value.

Parameters:

value - given direction value

Returns:

the direction enumeration

Throws:

IllegalArgumentException - in case the given value cannot be parsed into an enum value.

fromStringOrNull

public static Direction fromStringOrNull(String value)

Returns the Direction enum for the given String or null if it cannot be parsed into an enum value.

Parameters:

value - given direction value

Returns:

the appropriate direction enum or null