org.jlab.coda.cMsg.remoteExec

Enum CallbackState

java.lang.Object

java.lang.Enum<CallbackState>

org.jlab.coda.cMsg.remoteExec.CallbackState

All Implemented Interfaces:

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

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

Enumerate the possible states of a callback.

Author:

timmer Date: Nov 2, 2010

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELLED Callback was cancelled by calling Commander.cancelCallback(CommandReturn).
ERROR Callback cancelled because error getting process or thread to run.
KILLED Callback was cancelled by killing executor with calls to Commander.kill(org.jlab.coda.cMsg.remoteExec.ExecutorInfo, boolean) or Commander.killAll(boolean).
NONE No callback exists.
PENDING Callback is scheduled to be run.
RUN Callback was already run.
STOPPED Callback was cancelled by stopping executor process or thread with calls to Commander.stop(org.jlab.coda.cMsg.remoteExec.ExecutorInfo, org.jlab.coda.cMsg.remoteExec.CommandReturn) or Commander.stopAll(org.jlab.coda.cMsg.remoteExec.ExecutorInfo).

Method Summary

Modifier and Type	Method and Description
static CallbackState	getCallbackState(java.lang.String value) Obtain the enum from the value.
static java.lang.String	getName(java.lang.String value) Obtain the name from the value.
java.lang.String	getValue() Get the enum's value.
static CallbackState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CallbackState[]	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

NONE

public static final CallbackState NONE

No callback exists.

RUN

public static final CallbackState RUN

Callback was already run.

ERROR

public static final CallbackState ERROR

Callback cancelled because error getting process or thread to run.

PENDING

public static final CallbackState PENDING

Callback is scheduled to be run.

KILLED

public static final CallbackState KILLED

Callback was cancelled by killing executor with calls to Commander.kill(org.jlab.coda.cMsg.remoteExec.ExecutorInfo, boolean) or Commander.killAll(boolean).

STOPPED

public static final CallbackState STOPPED

Callback was cancelled by stopping executor process or thread with calls to Commander.stop(org.jlab.coda.cMsg.remoteExec.ExecutorInfo, org.jlab.coda.cMsg.remoteExec.CommandReturn) or Commander.stopAll(org.jlab.coda.cMsg.remoteExec.ExecutorInfo).

CANCELLED

public static final CallbackState CANCELLED

Callback was cancelled by calling Commander.cancelCallback(CommandReturn).

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public java.lang.String getValue()

Get the enum's value.

Returns:

the value, e.g., "reporting" for an REPORTING.

getName

public static java.lang.String getName(java.lang.String value)

Obtain the name from the value.

Parameters:

value - the value to match.

Returns:

the name, or null.

getCallbackState

public static CallbackState getCallbackState(java.lang.String value)

Obtain the enum from the value.

Parameters:

value - the value to match.

Returns:

the matching enum, or null.