Package nl.tno.imb.mc

Enum ModelState

java.lang.Object

java.lang.Enum<ModelState>

nl.tno.imb.mc.ModelState

All Implemented Interfaces:

Serializable, Comparable<ModelState>, java.lang.constant.Constable

public enum ModelState
extends Enum<ModelState>

The possible states of a model.

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
BUSY	Busy.
CALCULATING	Calculating.
IDLE	Model is available for use.
LOCK	Claim model for use in this session.
READY	Ready.
REMOVED	Model is no longer available.
UNLOCK	Free model to be used in other session.

Field Summary

Fields

Modifier and Type	Field	Description
protected static Map<Integer,ModelState>	commandMap	Map to translate numeric value to enum.

Method Summary

Modifier and Type	Method	Description
protected static ModelState	byValue(int value)	Lookup the ModelState that corresponds to the value.
int	getValue()	Retrieve the integer value that represents this ModelState for transmission over IMB.
static ModelState	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ModelState[]	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, 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

READY

public static final ModelState READY

Ready.

CALCULATING

public static final ModelState CALCULATING

Calculating.

BUSY

public static final ModelState BUSY

Busy.

IDLE

public static final ModelState IDLE

Model is available for use.

LOCK

public static final ModelState LOCK

Claim model for use in this session.

UNLOCK

public static final ModelState UNLOCK

Free model to be used in other session.

REMOVED

public static final ModelState REMOVED

Model is no longer available.

Field Details

commandMap

protected static Map<Integer,ModelState> commandMap

Map to translate numeric value to enum.

Method Details

values

public static ModelState[] values()

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

Returns:

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

valueOf

public static ModelState valueOf(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:

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

NullPointerException - if the argument is null

getValue

public int getValue()

Retrieve the integer value that represents this ModelState for transmission over IMB.

Returns:

int; the value that represents this ModelState in transmission over IMB

byValue

protected static ModelState byValue(int value)

Lookup the ModelState that corresponds to the value.

Parameters:

value - int; the value to look up

Returns:

ModelState; the ModelState that corresponds to the value, or null if no ModelState with the specified value is defined