com.whitestein.lsps.engine.dto

Enum PlanState

java.lang.Object

java.lang.Enum<PlanState>

com.whitestein.lsps.engine.dto.PlanState

All Implemented Interfaces:

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

public enum PlanState
extends java.lang.Enum<PlanState>
implements java.io.Serializable

Enum class that represents plan state. Each plan can be only in one of the states INACTIVE, RUNNING, ACHIEVED, FAILED.

You can compare two PlanStates for equality with built-in Enum.equals(Object) or with faster == operator. This holds even if the class is deserialized from serialized form.

Author:

rba

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACHIEVED Achieved plan state
FAILED Failed plan state
INACTIVE Inactive plan state
RUNNING Running plan state

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Set<PlanState>	ACTIVE_PLAN_STATES Set of active plan states.
static java.util.Set<PlanState>	FINISHED_PLAN_STATES Set of finished plan states.

Method Summary

Modifier and Type	Method and Description
abstract boolean	canBeChangedFromState(PlanState oldState) Returns true if a plan can be changed from state oldState to this state.
boolean	canBeChangedToState(PlanState newState) Returns true if a plan can be changed from this state to state newState.
static PlanState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PlanState[]	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

INACTIVE

public static final PlanState INACTIVE

Inactive plan state

RUNNING

public static final PlanState RUNNING

Running plan state

ACHIEVED

public static final PlanState ACHIEVED

Achieved plan state

FAILED

public static final PlanState FAILED

Failed plan state

Field Detail

ACTIVE_PLAN_STATES

public static final java.util.Set<PlanState> ACTIVE_PLAN_STATES

Set of active plan states.

FINISHED_PLAN_STATES

public static final java.util.Set<PlanState> FINISHED_PLAN_STATES

Set of finished plan states.

Method Detail

values

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

Returns:

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

valueOf

public static PlanState 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

canBeChangedFromState

public abstract boolean canBeChangedFromState(PlanState oldState)

Returns true if a plan can be changed from state oldState to this state.

Parameters:

oldState - old plan state

Returns:

true if a plan can be changed from state oldState to this state

canBeChangedToState

public final boolean canBeChangedToState(PlanState newState)

Returns true if a plan can be changed from this state to state newState.

Parameters:

newState - new plan state

Returns:

true if a plan can be changed from this state to state newState