org.apache.flink.table.annotation

Enum HintFlag

java.lang.Object

java.lang.Enum<HintFlag>

org.apache.flink.table.annotation.HintFlag

All Implemented Interfaces:

Serializable, Comparable<HintFlag>

@PublicEvolving
public enum HintFlag
extends Enum<HintFlag>

Three-valued flag for representing TRUE, FALSE, and UNKNOWN.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FALSE
TRUE
UNKNOWN

Method Summary

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

TRUE

public static final HintFlag TRUE

FALSE

public static final HintFlag FALSE

UNKNOWN

public static final HintFlag UNKNOWN

Method Detail

values

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

Returns:

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

valueOf

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