com.day.cq.reporting

Enum Sorting.Direction

java.lang.Object

java.lang.Enum<Sorting.Direction>

com.day.cq.reporting.Sorting.Direction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Sorting.Direction>

Enclosing interface:

Sorting

public static enum Sorting.Direction
extends java.lang.Enum<Sorting.Direction>

Defines available sorting directions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCENDING Sort ascending
DESCENDING Sort descending

Method Summary

Modifier and Type	Method and Description
static Sorting.Direction	fromStringRepresentation(java.lang.String strRep) Returns the corresponding Direction value for the specified string representation.
java.lang.String	getStringRepresentation() Gets the string representation of the direction.
static Sorting.Direction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Sorting.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

compareTo, equals, 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 Sorting.Direction ASCENDING

Sort ascending

DESCENDING

public static final Sorting.Direction DESCENDING

Sort descending

Method Detail

values

public static Sorting.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 (Sorting.Direction c : Sorting.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 Sorting.Direction 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

getStringRepresentation

public java.lang.String getStringRepresentation()

Gets the string representation of the direction.

Returns:

The string representation ("ASC", "DESC")

fromStringRepresentation

public static Sorting.Direction fromStringRepresentation(java.lang.String strRep)

Returns the corresponding Direction value for the specified string representation.

Parameters:

strRep - The string representation

Returns:

The corresponding Direction value; null if an invalid string representation was provided