Package org.apache.hadoop.fs.azurebfs.enums

Enum Class Trilean

java.lang.Object

java.lang.Enum<Trilean>

org.apache.hadoop.fs.azurebfs.enums.Trilean

All Implemented Interfaces:

Serializable, Comparable<Trilean>, Constable

public enum Trilean
extends Enum<Trilean>

Enum to represent 3 values, TRUE, FALSE and UNKNOWN. Can be used where boolean is not enough to hold the information.

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
FALSE
TRUE
UNKNOWN

Method Summary

Modifier and Type	Method	Description
static Trilean	getTrilean(boolean isTrue)	Converts boolean to Trilean.
static Trilean	getTrilean(String str)	Converts String to Trilean.
boolean	toBoolean()	Converts the Trilean enum to boolean.
static Trilean	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Trilean[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FALSE

public static final Trilean FALSE

TRUE

public static final Trilean TRUE

UNKNOWN

public static final Trilean UNKNOWN

Method Details

values

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

getTrilean

public static Trilean getTrilean(boolean isTrue)

Converts boolean to Trilean.

Parameters:

isTrue - the boolean to convert.

Returns:

the corresponding Trilean for the passed boolean isTrue.

getTrilean

public static Trilean getTrilean(String str)

Converts String to Trilean.

Parameters:

str - the string to convert.

Returns:

the corresponding Trilean for the passed string str.

toBoolean

public boolean toBoolean()
                  throws TrileanConversionException

Converts the Trilean enum to boolean.

Returns:

the corresponding boolean.

Throws:

TrileanConversionException - when tried to convert Trilean.UNKNOWN.