org.apache.flink.util

枚举 TernaryBoolean

java.lang.Object

java.lang.Enum<TernaryBoolean>

org.apache.flink.util.TernaryBoolean

所有已实现的接口:

Serializable, Comparable<TernaryBoolean>

@PublicEvolving
public enum TernaryBoolean
extends Enum<TernaryBoolean>

A ternary boolean, which can have the values 'true', 'false', or 'undefined'.

A ternary boolean can for example be used to configuration switches that may be not configured (undefined), in which case a default value should be assumed.

枚举常量概要

枚举常量

枚举常量和说明
FALSE The value for 'false'.
TRUE The value for 'true'.
UNDEFINED The value for 'undefined'.

方法概要

限定符和类型	方法和说明
static TernaryBoolean	fromBoolean(boolean bool) Converts the given boolean to a TernaryBoolean, TRUE or FALSE respectively.
static TernaryBoolean	fromBoxedBoolean(Boolean bool) Converts the given boxed Boolean to a TernaryBoolean.
Boolean	getAsBoolean() Gets this ternary boolean as a boxed boolean.
boolean	getOrDefault(boolean defaultValue) Gets the boolean value corresponding to this value.
TernaryBoolean	resolveUndefined(boolean valueForUndefined) Gets the boolean value corresponding to this value.
static TernaryBoolean	valueOf(String name) 返回带有指定名称的该类型的枚举常量。
static TernaryBoolean[]	values() 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。

从类继承的方法 java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

从类继承的方法 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

枚举常量详细资料

TRUE

public static final TernaryBoolean TRUE

The value for 'true'.

FALSE

public static final TernaryBoolean FALSE

The value for 'false'.

UNDEFINED

public static final TernaryBoolean UNDEFINED

The value for 'undefined'. In a configuration setting, this typically means that the default value will be used, or the value from a deployment-wide configuration.

方法详细资料

values

public static TernaryBoolean[] values()

按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:

for (TernaryBoolean c : TernaryBoolean.values())
    System.out.println(c);

返回:

按照声明该枚举类型的常量的顺序返回的包含这些常量的数组

valueOf

public static TernaryBoolean valueOf(String name)

返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符完全匹配。(不允许有多余 的空格字符。)

参数:

name - 要返回的枚举常量的名称。

返回:

返回带有指定名称的枚举常量

抛出:

IllegalArgumentException - 如果该枚举类型没有带有指定名称的常量

NullPointerException - 如果参数为空值

getOrDefault

public boolean getOrDefault(boolean defaultValue)

Gets the boolean value corresponding to this value. If this is the 'undefined' value, the method returns the given default.

参数:

defaultValue - The value to be returned in case this ternary value is 'undefined'.

resolveUndefined

public TernaryBoolean resolveUndefined(boolean valueForUndefined)

Gets the boolean value corresponding to this value. If this is the 'UNDEFINED' value, the method returns the given valueForUndefined.

参数:

valueForUndefined - The value to be returned in case this ternary value is 'undefined'.

getAsBoolean

@Nullable
public Boolean getAsBoolean()

Gets this ternary boolean as a boxed boolean. The value 'undefined' results in 'null.

fromBoolean

public static TernaryBoolean fromBoolean(boolean bool)

Converts the given boolean to a TernaryBoolean, TRUE or FALSE respectively.

fromBoxedBoolean

public static TernaryBoolean fromBoxedBoolean(@Nullable
                                              Boolean bool)

Converts the given boxed Boolean to a TernaryBoolean. A null value results in UNDEFINED, while a non-null value results in TRUE or FALSE respectively.