org.jppf.client

Enum JobStatus

java.lang.Object

java.lang.Enum<JobStatus>

org.jppf.client.JobStatus

All Implemented Interfaces:

Serializable, Comparable<JobStatus>

public enum JobStatus
extends Enum<JobStatus>

The status of a job.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLETE The job execution is complete.
EXECUTING The job is being executed.
FAILED The job execution has failed.
PENDING The job is currently in the job queue (on the client side).
SUBMITTED The job was just submitted.

Method Summary

Modifier and Type	Method and Description
boolean	isDone() Return whether this status indicates that the job is done, that is, this status is either JobStatus.COMPLETE or JobStatus.FAILED.
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

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

SUBMITTED

public static final JobStatus SUBMITTED

The job was just submitted.

PENDING

public static final JobStatus PENDING

The job is currently in the job queue (on the client side).

EXECUTING

public static final JobStatus EXECUTING

The job is being executed.

COMPLETE

public static final JobStatus COMPLETE

The job execution is complete.

FAILED

public static final JobStatus FAILED

The job execution has failed.

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

isDone

public boolean isDone()

Return whether this status indicates that the job is done, that is, this status is either JobStatus.COMPLETE or JobStatus.FAILED.

Returns:

true if this status is JobStatus.COMPLETE or JobStatus.FAILED, false otherwise.