Package org.apache.gravitino.rel.expressions.sorts

Enum Class SortDirection

java.lang.Object

java.lang.Enum<SortDirection>

org.apache.gravitino.rel.expressions.sorts.SortDirection

All Implemented Interfaces:

Serializable, Comparable<SortDirection>, Constable

@Evolving
public enum SortDirection
extends Enum<SortDirection>

A sort direction used in sorting expressions.

Each direction has a default null ordering that is implied if no null ordering is specified explicitly.

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	Ascending sort direction.
DESCENDING	Descending sort direction.

Method Summary

Modifier and Type	Method	Description
NullOrdering	defaultNullOrdering()	Returns the default null ordering to use if no null ordering is specified explicitly.
static SortDirection	fromString(String str)	Returns the SortDirection from the string representation.
String	toString()
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

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ASCENDING

public static final SortDirection ASCENDING

Ascending sort direction. Nulls appear first. For ascending order, this means nulls appear at the beginning.

DESCENDING

public static final SortDirection DESCENDING

Descending sort direction. Nulls appear last. For ascending order, this means nulls appear at the end.

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

defaultNullOrdering

public NullOrdering defaultNullOrdering()

Returns the default null ordering to use if no null ordering is specified explicitly.

Returns:

The default null ordering.

toString

public String toString()

Overrides:

toString in class Enum<SortDirection>

fromString

public static SortDirection fromString(String str)

Returns the SortDirection from the string representation.

Parameters:

str - The string representation of the sort direction.

Returns:

The SortDirection.