org.apache.jackrabbit.commons.query.qom

Enum Order

java.lang.Object

java.lang.Enum<Order>

org.apache.jackrabbit.commons.query.qom.Order

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Order>

public enum Order
extends java.lang.Enum<Order>

Enumeration of the JCR 2.0 query order.

Since:

Apache Jackrabbit 2.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCENDING
DESCENDING

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName()
static Order	getOrderByName(java.lang.String name) Return the order with the given JCR name.
static Order	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Order[]	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 Order ASCENDING

DESCENDING

public static final Order DESCENDING

Method Detail

values

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

Returns:

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

valueOf

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

getName

public java.lang.String getName()

Returns:

the JCR name of this order.

getOrderByName

public static Order getOrderByName(java.lang.String name)

Return the order with the given JCR name.

Parameters:

name - the JCR name of an order.

Returns:

the order with the given name.

Throws:

java.lang.IllegalArgumentException - if name is not a known JCR order name.