Package org.apache.spark.sql.connector.expressions

Enum Class NullOrdering

Object

Enum<NullOrdering>

org.apache.spark.sql.connector.expressions.NullOrdering

All Implemented Interfaces:

Serializable, Comparable<NullOrdering>, Constable

@Experimental
public enum NullOrdering
extends Enum<NullOrdering>

A null order used in sorting expressions.

Since:

3.2.0

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
NULLS_FIRST
NULLS_LAST

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NULLS_FIRST

public static final NullOrdering NULLS_FIRST

NULLS_LAST

public static final NullOrdering NULLS_LAST

Method Details

values

public static NullOrdering[] 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 NullOrdering 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

toString

public String toString()

Overrides:

toString in class Enum<NullOrdering>