Package org.apache.flink.table.functions

Enum TableSemantics.SortDirection

java.lang.Object

java.lang.Enum<TableSemantics.SortDirection>

org.apache.flink.table.functions.TableSemantics.SortDirection

All Implemented Interfaces:

Serializable, Comparable<TableSemantics.SortDirection>, java.lang.constant.Constable

Enclosing interface:

TableSemantics

@PublicEvolving
public static enum TableSemantics.SortDirection
extends Enum<TableSemantics.SortDirection>

The sort direction for ORDER BY columns in table arguments with set semantics.

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
ASC_NULLS_FIRST	Ascending order with nulls first.
ASC_NULLS_LAST	Ascending order with nulls last.
DESC_NULLS_FIRST	Descending order with nulls first.
DESC_NULLS_LAST	Descending order with nulls last.

Method Summary

Modifier and Type	Method	Description
boolean	isDescending()	Returns true if this is a descending sort direction.
boolean	isNullsFirst()	Returns true if nulls should be sorted first.
boolean	isNullsLast()	Returns true if nulls should be sorted last.
static TableSemantics.SortDirection	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TableSemantics.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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ASC_NULLS_FIRST

public static final TableSemantics.SortDirection ASC_NULLS_FIRST

Ascending order with nulls first.

ASC_NULLS_LAST

public static final TableSemantics.SortDirection ASC_NULLS_LAST

Ascending order with nulls last.

DESC_NULLS_FIRST

public static final TableSemantics.SortDirection DESC_NULLS_FIRST

Descending order with nulls first.

DESC_NULLS_LAST

public static final TableSemantics.SortDirection DESC_NULLS_LAST

Descending order with nulls last.

Method Details

values

public static TableSemantics.SortDirection[] values()

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

Returns:

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

valueOf

public static TableSemantics.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

isDescending

public boolean isDescending()

Returns true if this is a descending sort direction.

isNullsFirst

public boolean isNullsFirst()

Returns true if nulls should be sorted first.

isNullsLast

public boolean isNullsLast()

Returns true if nulls should be sorted last.