com.norconex.jef4.status

Enum JobState

java.lang.Object

java.lang.Enum<JobState>

com.norconex.jef4.status.JobState

All Implemented Interfaces:

Serializable, Comparable<JobState>

public enum JobState
extends Enum<JobState>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORTED The job was aborted (i.e.
COMPLETED The job execution has completed successfully.
PREMATURE_TERMINATION The job stopped running on its own, but has not reached 100% completion.
RUNNING The job is currently running.
STOPPED A request to stop job execution has been received and the job stopped.
STOPPING A request to stop job execution has been received and the job is currently stopping.
UNKNOWN Job execution status is unknown.

Method Summary

Modifier and Type	Method and Description
boolean	isOneOf(JobState... jobStates)
static JobState	valueOf(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

ABORTED

public static final JobState ABORTED

The job was aborted (i.e. killed). That is, if a job was started and is no longer running, while it never was marked as completed or stopped. Under normal conditions, a job should always finish, whether it failed or not. An aborted progress is usually the results of a job suite which got "killed" in the middle of its execution (not having the chance to return properly).

COMPLETED

public static final JobState COMPLETED

The job execution has completed successfully.

PREMATURE_TERMINATION

public static final JobState PREMATURE_TERMINATION

The job stopped running on its own, but has not reached 100% completion.

RUNNING

public static final JobState RUNNING

The job is currently running.

UNKNOWN

public static final JobState UNKNOWN

Job execution status is unknown. This status is returned when there was no way to establish actual status, for unpredictable reasons.

STOPPING

public static final JobState STOPPING

A request to stop job execution has been received and the job is currently stopping.

STOPPED

public static final JobState STOPPED

A request to stop job execution has been received and the job stopped.

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(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

isOneOf

public boolean isOneOf(JobState... jobStates)