edu.nrao.sss.sort
Enum SortOrder

java.lang.Object
  java.lang.Enum<SortOrder>
      edu.nrao.sss.sort.SortOrder

All Implemented Interfaces:

Serializable, Comparable<SortOrder>

public enum SortOrder
extends Enum<SortOrder>

Gives direction to sort keys.

Version Info:

$Revision: 593 $

$Date: 2007-05-07 15:54:14 -0600 (Mon, 07 May 2007) $

$Author: dharland $

Since:

2007-05-03

Author:

David M. Harland

Enum Constant Summary

AS_IS
An ordering from undisturbed from its current order.

ASCENDING
An ordering from lowest to highest.

CUSTOM
An ordering of custom design.

DESCENDING
An ordering from highest to lowest.

NATURAL
An ordering deemed to be natural, usually by the object being sorted.

Method Summary

static SortOrder	valueOf(String name) Returns the enum constant of this type with the specified name.
static SortOrder[]	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

NATURAL

public static final SortOrder NATURAL

An ordering deemed to be natural, usually by the object being sorted.

ASCENDING

public static final SortOrder ASCENDING

An ordering from lowest to highest.

DESCENDING

public static final SortOrder DESCENDING

An ordering from highest to lowest.

AS_IS

public static final SortOrder AS_IS

An ordering from undisturbed from its current order.

CUSTOM

public static final SortOrder CUSTOM

An ordering of custom design. Note that some objects that have a sort order do not accept this element.

Method Detail

values

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

Returns:

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

valueOf

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