org.apache.gravitino.rel.expressions.sorts

Enum SortDirection

java.lang.Object

java.lang.Enum<SortDirection>

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

All Implemented Interfaces:

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

@Evolving
public enum SortDirection
extends java.lang.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.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCENDING Ascending sort direction.
DESCENDING Descending sort direction.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 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(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

java.lang.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 java.lang.String toString()

Overrides:

toString in class java.lang.Enum<SortDirection>

fromString

public static SortDirection fromString(java.lang.String str)

Returns the SortDirection from the string representation.

Parameters:

str - The string representation of the sort direction.

Returns:

The SortDirection.