Package uk.gov.gchq.gaffer.jobtracker

Enum JobStatus

java.lang.Object

java.lang.Enum<JobStatus>

uk.gov.gchq.gaffer.jobtracker.JobStatus

All Implemented Interfaces:

Serializable, Comparable<JobStatus>

public enum JobStatus
extends Enum<JobStatus>

Denotes the status of a Gaffer job.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELLED	The Gaffer job is cancelled (to be used for scheduled jobs).
FAILED	An error occured while executing the Gaffer job.
FINISHED	The Gaffer job has completed successfully.
RUNNING	The Gaffer job has been submitted and is running.
SCHEDULED_PARENT	The Gaffer job is a parent job to a scheduled job(s).

Method Summary

Modifier and Type	Method	Description
static JobStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static JobStatus[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RUNNING

public static final JobStatus RUNNING

The Gaffer job has been submitted and is running.

FINISHED

public static final JobStatus FINISHED

The Gaffer job has completed successfully.

FAILED

public static final JobStatus FAILED

An error occured while executing the Gaffer job.

SCHEDULED_PARENT

public static final JobStatus SCHEDULED_PARENT

The Gaffer job is a parent job to a scheduled job(s).

CANCELLED

public static final JobStatus CANCELLED

The Gaffer job is cancelled (to be used for scheduled jobs).

Method Detail

values

public static JobStatus[] 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 c : JobStatus.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 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