org.eclipse.smila.jobmanager

Enum JobState

java.lang.Object

java.lang.Enum<JobState>

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

Enum Constants

Enum Constant and Description
CANCELED cancellation has finished.
CANCELLING cancellation has started but not yet finished.
CLEANINGUP cleaning up job run.
COMPLETING completing job run (completion tasks may be run) but not done yet.
FAILED failed.
FINISHING finished but not yet completing.
PREPARING started but not running yet.
RUNNING running.
SUCCEEDED successfully completed and cleaned up.

Method Summary

Methods

Modifier and Type	Method and Description
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 job run (completion tasks may be run) but not done yet.

CLEANINGUP

public static final JobState CLEANINGUP

cleaning up job run.

SUCCEEDED

public static final JobState SUCCEEDED

successfully completed and cleaned up.

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