Module com.genologics.ri

Package com.genologics.ri.step

Enum Class Status

java.lang.Object

java.lang.Enum<Status>

com.genologics.ri.step.Status

All Implemented Interfaces:

Serializable, Comparable<Status>, Constable

public enum Status
extends Enum<Status>

Enumeration of status values for a step.

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
ERROR	The step completed with errors.
OK	The step completed successfully.
QUEUED	The step is queued for execution.
RUNNING	The step is currently running.
WARNING	The step completed with warnings.

Method Summary

Modifier and Type	Method	Description
static Status	fromValue(String v)	Creates a status from a string value.
String	value()	Gets the string value of the status.
static Status	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Status[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OK

public static final Status OK

The step completed successfully.

ERROR

public static final Status ERROR

The step completed with errors.

WARNING

public static final Status WARNING

The step completed with warnings.

RUNNING

public static final Status RUNNING

The step is currently running.

QUEUED

public static final Status QUEUED

The step is queued for execution.

Since:

2.18

Method Details

values

public static Status[] 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 Status 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

value

public String value()

Gets the string value of the status.

Returns:

The name of the status.

fromValue

public static Status fromValue(String v)

Creates a status from a string value.

Parameters:

v - The string value of the status.

Returns:

The status corresponding to the value.

Throws:

IllegalArgumentException - if the value does not match any status.