org.kuali.rice.krad.data.metadata

Enum SortDirection

java.lang.Object

java.lang.Enum<SortDirection>

org.kuali.rice.krad.data.metadata.SortDirection

All Implemented Interfaces:

Serializable, Comparable<SortDirection>

public enum SortDirection
extends Enum<SortDirection>

Sorting orders used for collection definitions and lookup generation.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCENDING
ASCENDING_NULLS_FIRST
ASCENDING_NULLS_LAST
DESCENDING
DESCENDING_NULLS_FIRST
DESCENDING_NULLS_LAST

Method Summary

Methods

Modifier and Type	Method and Description
static SortDirection	valueOf(String name) Returns the enum constant of this type with the specified name.
static SortDirection[]	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 SortDirection ASCENDING

DESCENDING

public static final SortDirection DESCENDING

ASCENDING_NULLS_FIRST

public static final SortDirection ASCENDING_NULLS_FIRST

ASCENDING_NULLS_LAST

public static final SortDirection ASCENDING_NULLS_LAST

DESCENDING_NULLS_FIRST

public static final SortDirection DESCENDING_NULLS_FIRST

DESCENDING_NULLS_LAST

public static final SortDirection DESCENDING_NULLS_LAST

Method Detail

values

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

Returns:

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

valueOf

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