org.josef.util

Enum Order

java.lang.Object

java.lang.Enum<Order>

org.josef.util.Order

All Implemented Interfaces:

Serializable, Comparable<Order>

@Status(stage=PRODUCTION,
        unitTests=COMPLETE)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
public enum Order
extends Enum<Order>

Determines how things are ordered.

Version:

1.0 $Revision: 6298 $

Author:

Theo Vlastuin

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCENDING Ascending.
DESCENDING Descending.

Method Summary

Modifier and Type	Method and Description
String	toString() Creates a String representation of this Order such that it is usable with both SQL and JPQL.
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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ASCENDING

public static final Order ASCENDING

Ascending.

DESCENDING

public static final Order DESCENDING

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

toString

public String toString()

Creates a String representation of this Order such that it is usable with both SQL and JPQL.

Overrides:

toString in class Enum<Order>

Returns:

A String representation of this Order such that it is usable with both SQL and JPQL.