com.whitestein.lsps.engine.dto

Enum GoalState

java.lang.Object

java.lang.Enum<GoalState>

com.whitestein.lsps.engine.dto.GoalState

All Implemented Interfaces:

Serializable, Comparable<GoalState>

public enum GoalState
extends Enum<GoalState>
implements Serializable

Enum class representing goal state. Each goal is always in one of the states INACTIVE, READY, RUNNING, DEACTIVATED, FAILED, ACHIEVED.

You can compare two GoalStates 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 goal state
DEACTIVATED Deactivated goal state
FAILED Failed goal state
INACTIVE Inactive goal state
READY Ready goal state
RUNNING Running goal state

Field Summary

Fields

Modifier and Type	Field and Description
static Set<GoalState>	ACTIVE_GOAL_STATES Set containing active goal states.
static Set<GoalState>	FINISHED_GOAL_STATES Set containing finished goal states.

Method Summary

Modifier and Type	Method and Description
boolean	canBeActivated() Returns true if the goal can be activated.
abstract boolean	canBeChangedFromState(GoalState oldState) Returns true if a goal can change its goal state from oldState to this state.
boolean	canBeChangedToState(GoalState newState) Returns true if a goal can change its goal state from this state to newState.
boolean	canBeDeactivated() Returns true if the goal can be deactivated.
static GoalState	valueOf(String name) Returns the enum constant of this type with the specified name.
static GoalState[]	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 GoalState INACTIVE

Inactive goal state

READY

public static final GoalState READY

Ready goal state

RUNNING

public static final GoalState RUNNING

Running goal state

DEACTIVATED

public static final GoalState DEACTIVATED

Deactivated goal state

FAILED

public static final GoalState FAILED

Failed goal state

ACHIEVED

public static final GoalState ACHIEVED

Achieved goal state

Field Detail

FINISHED_GOAL_STATES

public static final Set<GoalState> FINISHED_GOAL_STATES

Set containing finished goal states.

ACTIVE_GOAL_STATES

public static final Set<GoalState> ACTIVE_GOAL_STATES

Set containing active goal states.

Method Detail

values

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

Returns:

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

valueOf

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

canBeActivated

public boolean canBeActivated()

Returns true if the goal can be activated.

Returns:

true if the goal can be activated

canBeDeactivated

public boolean canBeDeactivated()

Returns true if the goal can be deactivated.

Returns:

true if the goal can be deactivated

canBeChangedToState

public final boolean canBeChangedToState(GoalState newState)

Returns true if a goal can change its goal state from this state to newState.

Parameters:

newState - new goal state

Returns:

true if a goal can change its goal state from this state to newState.

canBeChangedFromState

public abstract boolean canBeChangedFromState(GoalState oldState)

Returns true if a goal can change its goal state from oldState to this state.

Parameters:

oldState - old goal state

Returns:

true if a goal can change its goal state from oldState to this state.