org.apache.spark.sql.connector.expressions

Enum NullOrdering

Object

Enum<NullOrdering>

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

All Implemented Interfaces:

java.io.Serializable, Comparable<NullOrdering>

@Experimental
public enum NullOrdering
extends Enum<NullOrdering>

A null order used in sorting expressions.

Since:

3.2.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
NULLS_FIRST
NULLS_LAST

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NULLS_FIRST

public static final NullOrdering NULLS_FIRST

NULLS_LAST

public static final NullOrdering NULLS_LAST

Method Detail

values

public static NullOrdering[] 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 (NullOrdering c : NullOrdering.values())
    System.out.println(c);

Returns:

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

valueOf

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

toString

public String toString()

Overrides:

toString in class Enum<NullOrdering>