Package com.mayam.wf.mq.property

Enum Class JobState

java.lang.Object

java.lang.Enum<JobState>

com.mayam.wf.mq.property.JobState

All Implemented Interfaces:

Serializable, Comparable<JobState>, Constable

public enum JobState
extends Enum<JobState>

The MayamJobState property describes job state. Found in messages of type MessageType.JOB.

Author:

Mahesh Ramani, Markus Mårtensson

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABORTED	Job was aborted.
DONE	Job finished successfully.
FAILED	Job has failed.
PENDING	Job is waiting to start.
RUNNING	Job is currently running.
STARTED	Job has started and is currently running.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_NAME

Method Summary

Modifier and Type	Method	Description
static JobState	fromMessage(MqMessage message)	Returns the JobState of a message.
static JobState	fromString(String value)	Looks up a JobState based on its message property value form.
String	toString()
static JobState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JobState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PENDING

public static final JobState PENDING

Job is waiting to start.

DONE

public static final JobState DONE

Job finished successfully.

STARTED

public static final JobState STARTED

Job has started and is currently running.

RUNNING

public static final JobState RUNNING

Job is currently running.

FAILED

public static final JobState FAILED

Job has failed.

ABORTED

public static final JobState ABORTED

Job was aborted.

Field Details

PROPERTY_NAME

public static final String PROPERTY_NAME

See Also:

• Constant Field Values

Method Details

values

public static JobState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static JobState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<JobState>

fromString

public static JobState fromString(String value)

Looks up a JobState based on its message property value form.

Parameters:

value - property value.

Returns:

job state, or null if invalid (or input was null).

fromMessage

public static JobState fromMessage(MqMessage message)

Returns the JobState of a message.