Module io.github.tonywasher.joceanus.gordianknot

Package io.github.tonywasher.joceanus.gordianknot.api.base

Enum Class GordianRequired

java.lang.Object

java.lang.Enum<GordianRequired>

io.github.tonywasher.joceanus.gordianknot.api.base.GordianRequired

All Implemented Interfaces:

Serializable, Comparable<GordianRequired>, Constable

public enum GordianRequired
extends Enum<GordianRequired>

Is an item required? Possible/Always/Never.

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
ALWAYS	Always.
NEVER	Never.
POSSIBLE	Possible.

Method Summary

Modifier and Type	Method	Description
boolean	canExist()	can the item exist?
boolean	canNotExist()	can the item not exist?
boolean	mustExist()	must the item exist?
boolean	mustNotExist()	must the item not exist?
static GordianRequired	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GordianRequired[]	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

NEVER

public static final GordianRequired NEVER

Never.

POSSIBLE

public static final GordianRequired POSSIBLE

Possible.

ALWAYS

public static final GordianRequired ALWAYS

Always.

Method Details

values

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

canExist

public boolean canExist()

can the item exist?

Returns:

true/false

canNotExist

public boolean canNotExist()

can the item not exist?

Returns:

true/false

mustExist

public boolean mustExist()

must the item exist?

Returns:

true/false

mustNotExist

public boolean mustNotExist()

must the item not exist?

Returns:

true/false