Package net.solarnetwork.domain

Enum Class InstructionStatus.InstructionState

java.lang.Object

java.lang.Enum<InstructionStatus.InstructionState>

net.solarnetwork.domain.InstructionStatus.InstructionState

All Implemented Interfaces:

Serializable, Comparable<InstructionStatus.InstructionState>, Constable

Enclosing interface:

InstructionStatus

public static enum InstructionStatus.InstructionState
extends Enum<InstructionStatus.InstructionState>

An enumeration of instruction states.

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
Completed	The instruction was received and has been executed.
Declined	The instruction was received but the recipient has declined to execute the instruction.
Executing	The instruction has been received and is being executed by the recipient currently.
Queued	The instruction has been queued on the sender for the recipient.
Queuing	The instruction is in the process of being queued, potentially jumping to the received state if an immediate acknowledgement is possible.
Received	The recipient has acknowledged receipt of the instruction, but has not been processed yet.
Unknown	The instruction state is not known.

Method Summary

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

The instruction state is not known.

Queued

public static final InstructionStatus.InstructionState Queued

The instruction has been queued on the sender for the recipient.

Queuing

public static final InstructionStatus.InstructionState Queuing

The instruction is in the process of being queued, potentially jumping to the received state if an immediate acknowledgement is possible.

Received

public static final InstructionStatus.InstructionState Received

The recipient has acknowledged receipt of the instruction, but has not been processed yet. It will be processed at as soon as possible.

Executing

public static final InstructionStatus.InstructionState Executing

The instruction has been received and is being executed by the recipient currently.

Declined

public static final InstructionStatus.InstructionState Declined

The instruction was received but the recipient has declined to execute the instruction.

Completed

public static final InstructionStatus.InstructionState Completed

The instruction was received and has been executed.

Method Details

values

public static InstructionStatus.InstructionState[] 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 InstructionStatus.InstructionState 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