Package com.deltawalker.script

Enum Class SortDirection

java.lang.Object

java.lang.Enum<SortDirection>

com.deltawalker.script.SortDirection

All Implemented Interfaces:

Serializable, Comparable<SortDirection>, Constable

public enum SortDirection
extends Enum<SortDirection>

Specifies the direction in which to sort a list of items.

Since:

2.0

See Also:

• FolderComparison.sort(Role, SortBy, SortDirection)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASCENDING	Sort from smallest to largest.
DESCENDING	Sort from largest to smallest.

Method Summary

Modifier and Type	Method	Description
static SortDirection	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SortDirection[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ASCENDING

public static final SortDirection ASCENDING

Sort from smallest to largest. For example, from A to Z.

DESCENDING

public static final SortDirection DESCENDING

Sort from largest to smallest. For example, from Z to A.

Method Details

values

public static SortDirection[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SortDirection valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null