com.marklogic.hub.job

Enum JobStatus

java.lang.Object

java.lang.Enum<JobStatus>

com.marklogic.hub.job.JobStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JobStatus>

public enum JobStatus
extends java.lang.Enum<JobStatus>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELED
FAILED
FINISHED
FINISHED_WITH_ERRORS
RUNNING
STARTED
STOP_ON_ERROR

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CANCELED_PREFIX
static java.lang.String	COMPLETED_PREFIX
static java.lang.String	COMPLETED_WITH_ERRORS_PREFIX
static java.lang.String	FAILED_PREFIX
static java.lang.String	RUNNING_PREFIX
static java.lang.String	STOP_ON_ERROR_PREFIX

Method Summary

Modifier and Type	Method and Description
static JobStatus	getJobStatus(java.lang.String status)
static boolean	isJobDone(java.lang.String jobStatus)
static boolean	isStepDone(java.lang.String status)
java.lang.String	toString()
static JobStatus	valueOf(java.lang.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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STARTED

public static final JobStatus STARTED

FINISHED

public static final JobStatus FINISHED

FINISHED_WITH_ERRORS

public static final JobStatus FINISHED_WITH_ERRORS

RUNNING

public static final JobStatus RUNNING

FAILED

public static final JobStatus FAILED

STOP_ON_ERROR

public static final JobStatus STOP_ON_ERROR

CANCELED

public static final JobStatus CANCELED

Field Detail

RUNNING_PREFIX

public static final java.lang.String RUNNING_PREFIX

See Also:

Constant Field Values

COMPLETED_PREFIX

public static final java.lang.String COMPLETED_PREFIX

See Also:

Constant Field Values

COMPLETED_WITH_ERRORS_PREFIX

public static final java.lang.String COMPLETED_WITH_ERRORS_PREFIX

See Also:

Constant Field Values

STOP_ON_ERROR_PREFIX

public static final java.lang.String STOP_ON_ERROR_PREFIX

See Also:

Constant Field Values

FAILED_PREFIX

public static final java.lang.String FAILED_PREFIX

See Also:

Constant Field Values

CANCELED_PREFIX

public static final java.lang.String CANCELED_PREFIX

See Also:

Constant Field Values

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(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getJobStatus

public static JobStatus getJobStatus(java.lang.String status)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<JobStatus>

isJobDone

public static boolean isJobDone(java.lang.String jobStatus)

isStepDone

public static boolean isStepDone(java.lang.String status)