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

java.lang.Object
  extended by java.lang.Enum<Order>
      extended by org.apache.jackrabbit.commons.query.qom.Order
All Implemented Interfaces:
Serializable, Comparable<Order>

public enum Order
extends Enum<Order>

Enumeration of the JCR 2.0 query order.

Since:
Apache Jackrabbit 2.0

Enum Constant Summary
ASCENDING
           
DESCENDING
           
 
Method Summary
 String getName()
           
static Order getOrderByName(String name)
          Return the order with the given JCR name.
static Order valueOf(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
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

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(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

getName

public String getName()
Returns:
the JCR name of this order.

getOrderByName

public static Order getOrderByName(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:
IllegalArgumentException - if name is not a known JCR order name.


Copyright © 2011-2013 Adobe Systems Incorporated. All Rights Reserved.