Module io.github.tonywasher.joceanus.metis

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

Enum Class MetisFieldState

java.lang.Object

java.lang.Enum<MetisFieldState>

io.github.tonywasher.joceanus.metis.field.MetisFieldState

All Implemented Interfaces:

Serializable, Comparable<MetisFieldState>, Constable

public enum MetisFieldState
extends Enum<MetisFieldState>

Enumeration of FieldSet states.

Author:

Tony Washer

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
CHANGED	Changed state.
DELETED	Deleted state.
ERROR	Error state.
NEW	New state.
NORMAL	Normal state.
RESTORED	Restored state.

Method Summary

Modifier and Type	Method	Description
boolean	isChanged()	Is the state changed?
boolean	isError()	Is the state in error?
static MetisFieldState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MetisFieldState[]	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

NORMAL

public static final MetisFieldState NORMAL

Normal state.

CHANGED

public static final MetisFieldState CHANGED

Changed state.

NEW

public static final MetisFieldState NEW

New state.

DELETED

public static final MetisFieldState DELETED

Deleted state.

RESTORED

public static final MetisFieldState RESTORED

Restored state.

ERROR

public static final MetisFieldState ERROR

Error state.

Method Details

values

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

isError

public boolean isError()

Is the state in error?

Returns:

true/false

isChanged

public boolean isChanged()

Is the state changed?

Returns:

true/false