Enum Class NullBool

java.lang.Object

java.lang.Enum<NullBool>

ch.andre601.advancedserverlist.api.objects.NullBool

All Implemented Interfaces:

Serializable, Comparable<NullBool>, Constable

public enum NullBool
extends Enum<NullBool>

Enum used to return a Boolean Value with a fallback, should the boolean be null.

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	Representation of the Boolean value false.
NOT_SET	Representation of a null Boolean value.
TRUE	Representation of the Boolean value true.

Method Summary

Modifier and Type	Method	Description
boolean	getOrDefault(boolean def)	Returns the NullBool's Boolean value or the provided def value, should the Instance be equal to NullBool.NOT_SET.
boolean	isNotSet()	Returns whether the NullBool Instance is NullBool.NOT_SET.
static @NonNull NullBool	resolve(@Nullable Boolean bool)	Returns a NullBool Instance based on the provided Boolean instance:
static NullBool	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NullBool[]	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

TRUE

public static final NullBool TRUE

Representation of the Boolean value true.

FALSE

public static final NullBool FALSE

Representation of the Boolean value false.

NOT_SET

public static final NullBool NOT_SET

Representation of a null Boolean value.

Method Details

values

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

resolve

public static @NonNull NullBool resolve(@Nullable Boolean bool)

Returns a NullBool Instance based on the provided Boolean instance:

• true will return NullBool.TRUE
• false will return NullBool.FALSE
• null will return NullBool.NOT_SET

Parameters:

bool - Boolean to obtain a NullBool Instance from.

Returns:

NullBool Instance based on the provided Boolean value.

isNotSet

public boolean isNotSet()

Returns whether the NullBool Instance is NullBool.NOT_SET.

Returns:

true if the Instance is equal to NullBool.NOT_SET.

getOrDefault

public boolean getOrDefault(boolean def)

Returns the NullBool's Boolean value or the provided def value, should the Instance be equal to NullBool.NOT_SET.

Parameters:

def - Default boolean value to return, should the NullBool instance be equal to NullBool.NOT_SET.

Returns:

true or false based on the NullBool's Instance and the provided def value.