com.jadeworld.jade.persistence
Enum KeyOrder

java.lang.Object
  java.lang.Enum<KeyOrder>
      com.jadeworld.jade.persistence.KeyOrder

All Implemented Interfaces:

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

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

Key order. /** Holds the valid values for the sort attribute of the DictionaryKey annotation.

Author:

JADE Development Centre, Jade Software Corporation Ltd.

Enum Constant Summary

ASCENDING
An ASCENDING key is in alphabetic sequence.

DESCENDING
A DESCENDING key is in reverse alphabetic sequence.

Method Summary

static KeyOrder	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static KeyOrder[]	values() Returns an array containing the constants of this enum type, in the order they're 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 KeyOrder ASCENDING

An ASCENDING key is in alphabetic sequence.

DESCENDING

public static final KeyOrder DESCENDING

A DESCENDING key is in reverse alphabetic sequence.

Method Detail

values

public static final KeyOrder[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(KeyOrder c : KeyOrder.values())
        System.out.println(c);

Returns:

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

valueOf

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