com.norconex.jef.progress
Enum IJobStatus.Status

java.lang.Object
  extended by java.lang.Enum<IJobStatus.Status>
      extended by com.norconex.jef.progress.IJobStatus.Status
All Implemented Interfaces:
Serializable, Comparable<IJobStatus.Status>
Enclosing interface:
IJobStatus

public static enum IJobStatus.Status
extends Enum<IJobStatus.Status>

A job execution status.


Enum Constant Summary
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 are stopped.
STOPPING
          A request to stop job execution has been received and the job are currently stopping.
UNKNOWN
          Job execution status is unknown.
 
Method Summary
static IJobStatus.Status valueOf(String name)
          Returns the enum constant of this type with the specified name.
static IJobStatus.Status[] 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 IJobStatus.Status 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 finished 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 IJobStatus.Status COMPLETED
The job execution has completed successfully.


PREMATURE_TERMINATION

public static final IJobStatus.Status PREMATURE_TERMINATION
The job stopped running on its own, but has not reached 100% completion.


RUNNING

public static final IJobStatus.Status RUNNING
The job is currently running.


UNKNOWN

public static final IJobStatus.Status 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 IJobStatus.Status STOPPING
A request to stop job execution has been received and the job are currently stopping.


STOPPED

public static final IJobStatus.Status STOPPED
A request to stop job execution has been received and the job are stopped.

Method Detail

values

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

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

valueOf

public static IJobStatus.Status 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


Copyright © 2007-2013 Norconex Inc.. All Rights Reserved.