org.corpus_tools.pepper.common

Enum JOB_STATUS

java.lang.Object

java.lang.Enum<JOB_STATUS>

org.corpus_tools.pepper.common.JOB_STATUS

All Implemented Interfaces:

Serializable, Comparable<JOB_STATUS>

public enum JOB_STATUS
extends Enum<JOB_STATUS>

Status of a job in Pepper, the status could be one of the following:

• NOT_STARTED, if the job was not started
• #IN_PROGRESS, if the job is running
• ENDED, if the job ended successful
• ENDED_WITH_ERRORS, if the job ended with errors

Author:

Florian Zipser

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENDED
ENDED_WITH_ERRORS
IMPORTING_CORPUS_STRUCTURE
IMPORTING_DOCUMENT_STRUCTURE
INITIALIZING
NOT_STARTED

Method Summary

Modifier and Type	Method and Description
boolean	isInProgress() Returns whether the status determines, that the Pepper job is still in progress.
String	toString()
static JOB_STATUS	valueOf(String name) Returns the enum constant of this type with the specified name.
static JOB_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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOT_STARTED

public static final JOB_STATUS NOT_STARTED

INITIALIZING

public static final JOB_STATUS INITIALIZING

IMPORTING_CORPUS_STRUCTURE

public static final JOB_STATUS IMPORTING_CORPUS_STRUCTURE

IMPORTING_DOCUMENT_STRUCTURE

public static final JOB_STATUS IMPORTING_DOCUMENT_STRUCTURE

ENDED

public static final JOB_STATUS ENDED

ENDED_WITH_ERRORS

public static final JOB_STATUS ENDED_WITH_ERRORS

Method Detail

values

public static JOB_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 (JOB_STATUS c : JOB_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 JOB_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

toString

public String toString()

Overrides:

toString in class Enum<JOB_STATUS>

isInProgress

public boolean isInProgress()

Returns whether the status determines, that the Pepper job is still in progress.

Returns:

true, if the type equals INITIALIZE, IMPORTING_CORPUS_STRUCTURE or IMPORTING_DOCUMENT_STRUCTURE