Package org.apereo.cas.configuration.support

Enum Class TriStateBoolean

java.lang.Object

java.lang.Enum<TriStateBoolean>

org.apereo.cas.configuration.support.TriStateBoolean

All Implemented Interfaces:

Serializable, Comparable<TriStateBoolean>, Constable

public enum TriStateBoolean
extends Enum<TriStateBoolean>

This is TriStateBoolean.

Since:

6.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TriStateBoolean.Deserializer

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FALSE	Constant to represent the false state.
TRUE	Constant to represent the true state.
UNDEFINED	Constant to represent the undefined state.

Method Summary

Modifier and Type	Method	Description
static TriStateBoolean	fromBoolean(boolean value)	From boolean.
boolean	isFalse()	Is false.
boolean	isTrue()	Is true.
boolean	isUndefined()	Is undefined.
Boolean	toBoolean()	To boolean.
static TriStateBoolean	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TriStateBoolean[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TRUE

public static final TriStateBoolean TRUE

Constant to represent the true state.

FALSE

public static final TriStateBoolean FALSE

Constant to represent the false state.

UNDEFINED

public static final TriStateBoolean UNDEFINED

Constant to represent the undefined state.

Method Details

values

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

fromBoolean

public static TriStateBoolean fromBoolean(boolean value)

From boolean.

Parameters:

value - the value

Returns:

the tri state boolean

isTrue

public boolean isTrue()

Is true.

Returns:

true/false

isFalse

public boolean isFalse()

Is false.

Returns:

true/false

isUndefined

public boolean isUndefined()

Is undefined.

Returns:

true/false

toBoolean

public Boolean toBoolean()

To boolean.

Returns:

true/false