Package uk.ac.manchester.spinnaker.spalloc.messages

Enum Class State

java.lang.Object

java.lang.Enum<State>

uk.ac.manchester.spinnaker.spalloc.messages.State

All Implemented Interfaces:

Serializable, Comparable<State>, Constable

public enum State
extends Enum<State>

The possible states of a spalloc job. In particular, the READY state indicates that the job is running/ready to run.

Author:

Donal Fellows

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
DESTROYED	SpallocJob has terminated, see the reason property for why.
POWER	SpallocJob is having its boards powered up.
QUEUED	SpallocJob is in the queue, awaiting allocation.
READY	SpallocJob is running (or at least ready to run).
UNKNOWN	SpallocJob is unknown.

Method Summary

Modifier and Type	Method	Description
static State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static State[]	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 State UNKNOWN

SpallocJob is unknown.

QUEUED

public static final State QUEUED

SpallocJob is in the queue, awaiting allocation.

POWER

public static final State POWER

SpallocJob is having its boards powered up.

READY

public static final State READY

SpallocJob is running (or at least ready to run).

DESTROYED

public static final State DESTROYED

SpallocJob has terminated, see the reason property for why.

Method Details

values

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