io.nexusrpc

Enum OperationState

java.lang.Object

java.lang.Enum<OperationState>

io.nexusrpc.OperationState

All Implemented Interfaces:

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

public enum OperationState
extends java.lang.Enum<OperationState>

State an operation can be in.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELED Indicates an operation completed as canceled.
FAILED Indicates an operation completed as failed.
RUNNING Indicates an operation is started and not yet completed.
SUCCEEDED Indicates an operation completed successfully.

Method Summary

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

RUNNING

public static final OperationState RUNNING

Indicates an operation is started and not yet completed.

SUCCEEDED

public static final OperationState SUCCEEDED

Indicates an operation completed successfully.

FAILED

public static final OperationState FAILED

Indicates an operation completed as failed.

CANCELED

public static final OperationState CANCELED

Indicates an operation completed as canceled.

Method Detail

values

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

Returns:

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

valueOf

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