org.xwiki.job.event.status

Enum JobStatus.State

java.lang.Object

java.lang.Enum<JobStatus.State>

org.xwiki.job.event.status.JobStatus.State

All Implemented Interfaces:

Serializable, Comparable<JobStatus.State>

Enclosing interface:

JobStatus

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

Job status.

Version:

$Id: 0888f4ab59e5938a6a48cd2ff6f329f7ca0839bc $

Enum Constant Summary

Enum Constants

Enum Constant and Description
FINISHED The job is done.
NONE Default status, generally mean that the task has not been started yet.
RUNNING The job is running.
WAITING The job is waiting.

Method Summary

Methods

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

NONE

public static final JobStatus.State NONE

Default status, generally mean that the task has not been started yet.

RUNNING

public static final JobStatus.State RUNNING

The job is running.

WAITING

public static final JobStatus.State WAITING

The job is waiting.

FINISHED

public static final JobStatus.State FINISHED

The job is done.

Method Detail

values

public static JobStatus.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 (JobStatus.State c : JobStatus.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 JobStatus.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