org.apache.calcite.rel.metadata

Enum NullSentinel

java.lang.Object

java.lang.Enum<NullSentinel>

org.apache.calcite.rel.metadata.NullSentinel

All Implemented Interfaces:

Serializable, Comparable<NullSentinel>

public enum NullSentinel
extends Enum<NullSentinel>

Placeholder for null values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE Placeholder that means that a request for metadata is already active, therefore this request forms a cycle.
INSTANCE Placeholder for a null value.

Method Summary

Modifier and Type	Method and Description
static Comparable	mask(@Nullable Comparable value)
static Object	mask(@Nullable Object value)
static NullSentinel	valueOf(String name) Returns the enum constant of this type with the specified name.
static NullSentinel[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final NullSentinel INSTANCE

Placeholder for a null value.

ACTIVE

public static final NullSentinel ACTIVE

Placeholder that means that a request for metadata is already active, therefore this request forms a cycle.

Method Detail

values

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

Returns:

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

valueOf

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

mask

public static Comparable mask(@Nullable Comparable value)

mask

public static Object mask(@Nullable Object value)