Package edu.tufts.hrilab.action.goal

Enum Class GoalStatus

java.lang.Object

java.lang.Enum<GoalStatus>

edu.tufts.hrilab.action.goal.GoalStatus

All Implemented Interfaces:

Serializable, Comparable<GoalStatus>, Constable

public enum GoalStatus
extends Enum<GoalStatus>

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
ACTIVE
CANCELED
FAILED
PENDING
SUCCEEDED
SUSPENDED
UNKNOWN

Method Summary

Modifier and Type	Method	Description
static GoalStatus	fromString(String string)	Case-insensitive version of valueOf.
boolean	isFailure()	Getter method for whether or not this enum instance represents a failure status.
boolean	isTerminated()	Getter method for whether this enum instance represents a terminal status.
static GoalStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GoalStatus[]	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

UNKNOWN

public static final GoalStatus UNKNOWN

PENDING

public static final GoalStatus PENDING

ACTIVE

public static final GoalStatus ACTIVE

SUSPENDED

public static final GoalStatus SUSPENDED

CANCELED

public static final GoalStatus CANCELED

SUCCEEDED

public static final GoalStatus SUCCEEDED

FAILED

public static final GoalStatus FAILED

Method Details

values

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

isTerminated

public boolean isTerminated()

Getter method for whether this enum instance represents a terminal status.

Returns:

isFailure

public boolean isFailure()

Getter method for whether or not this enum instance represents a failure status.

Returns:

fromString

public static GoalStatus fromString(String string)

Case-insensitive version of valueOf.

Parameters:

string -

Returns: