io.github.bananapuncher714.cartographer.core.api

Enum BooleanOption

java.lang.Object

java.lang.Enum<BooleanOption>

io.github.bananapuncher714.cartographer.core.api.BooleanOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BooleanOption>

public enum BooleanOption
extends java.lang.Enum<BooleanOption>

Boolean enum with UNSET option.

Author:

BananaPuncher714

Enum Constant Summary

Enum Constants

Enum Constant and Description
FALSE
TRUE
UNSET

Method Summary

Modifier and Type	Method and Description
boolean	isTrue() Check for true.
boolean	isUnset() Check for unset.
static BooleanOption	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BooleanOption[]	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 BooleanOption TRUE

FALSE

public static final BooleanOption FALSE

UNSET

public static final BooleanOption UNSET

Method Detail

values

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

Returns:

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

valueOf

public static BooleanOption valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isTrue

public boolean isTrue()

Check for true.

Returns:

If this enum is equal to TRUE.

isUnset

public boolean isUnset()

Check for unset.

Returns:

If this enum is equal to UNSET.