SMILA (incubation) API documentation

org.eclipse.smila.jobmanager
Enum JobState

java.lang.Object
  extended by java.lang.Enum<JobState>
      extended by org.eclipse.smila.jobmanager.JobState
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<JobState>

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

Job lifecycle states.


Enum Constant Summary
CANCELED
          cancellation has finished.
CANCELLING
          cancellation has started but not yet finished.
COMPLETING
          completing but not yet completed.
FAILED
          failed.
FINISHING
          finished but not yet completing.
PREPARING
          started but not running yet.
RUNNING
          running.
SUCCEEDED
          successfully completed.
 
Method Summary
static JobState valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static JobState[] 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

PREPARING

public static final JobState PREPARING
started but not running yet.


RUNNING

public static final JobState RUNNING
running.


FINISHING

public static final JobState FINISHING
finished but not yet completing.


COMPLETING

public static final JobState COMPLETING
completing but not yet completed.


SUCCEEDED

public static final JobState SUCCEEDED
successfully completed.


FAILED

public static final JobState FAILED
failed.


CANCELLING

public static final JobState CANCELLING
cancellation has started but not yet finished.


CANCELED

public static final JobState CANCELED
cancellation has finished.

Method Detail

values

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

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

valueOf

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

SMILA (incubation) API documentation