Module io.github.tonywasher.joceanus.metis

Package io.github.tonywasher.joceanus.metis.field

Enum Class MetisFieldRequired

java.lang.Object

java.lang.Enum<MetisFieldRequired>

io.github.tonywasher.joceanus.metis.field.MetisFieldRequired

All Implemented Interfaces:

Serializable, Comparable<MetisFieldRequired>, Constable

public enum MetisFieldRequired
extends Enum<MetisFieldRequired>

Field presence status.

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
CANEXIST	Can exist.
MUSTEXIST	Must exist.
NOTALLOWED	Not Allowed.

Method Summary

Modifier and Type	Method	Description
boolean	mustExist()	must the field exist?
boolean	notAllowed()	is the field notAllowed?
static MetisFieldRequired	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MetisFieldRequired[]	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

MUSTEXIST

public static final MetisFieldRequired MUSTEXIST

Must exist.

CANEXIST

public static final MetisFieldRequired CANEXIST

Can exist.

NOTALLOWED

public static final MetisFieldRequired NOTALLOWED

Not Allowed.

Method Details

values

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

mustExist

public boolean mustExist()

must the field exist?

Returns:

true/false

notAllowed

public boolean notAllowed()

is the field notAllowed?

Returns:

true/false