com.levigo.jadice.server

Enum Job.State

java.lang.Object

java.lang.Enum<Job.State>

com.levigo.jadice.server.Job.State

All Implemented Interfaces:

Serializable, Comparable<Job.State>

Enclosing class:

Job

public static enum Job.State
extends Enum<Job.State>

The different states a job can have.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORTED A job which terminated due to being forcefully aborted.
ACCEPTED A job which has been accepted by a server.
FAILED A job whose execution has failed for some reason.
FINISHED A job which is finished.
NEW A new job.
STARTED A job which is currently executing on a server.
SUBMITTED A job which has been submitted to a server for execution, but has not yet been accepted by a server.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isTerminalState() Return whether the state is a terminal state.
static Job.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static Job.State[]	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

NEW

public static final Job.State NEW

A new job. It may be configured and submitted for execution.

SUBMITTED

public static final Job.State SUBMITTED

A job which has been submitted to a server for execution, but has not yet been accepted by a server. In the JMS implementation, a job is submitted by posting it into a queue. Any number of servers may listen on this queue and accept jobs as they see fit. If all servers are busy, a job may rest in this state for some time, until a server accepts it or a submission timeout occurs.

ACCEPTED

public static final Job.State ACCEPTED

A job which has been accepted by a server. Execution of the job has, however, not yet commenced. A job may rest in this state while the server prepares it for execution. Due to resource allocation needs, this may not be instantaneously.

STARTED

public static final Job.State STARTED

A job which is currently executing on a server.

FINISHED

public static final Job.State FINISHED

A job which is finished. The execution was successful and all data has been processed.

FAILED

public static final Job.State FAILED

A job whose execution has failed for some reason.

ABORTED

public static final Job.State ABORTED

A job which terminated due to being forcefully aborted.

Method Detail

values

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

Returns:

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

valueOf

public static Job.State valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isTerminalState

public boolean isTerminalState()

Return whether the state is a terminal state. Jobs are automatically closed, once they enter a terminal state.

Returns:

true iff the current state is terminal