com.yahoo.bard.webservice.async.jobs.jobrows

Enum DefaultJobStatus

java.lang.Object

java.lang.Enum<DefaultJobStatus>

com.yahoo.bard.webservice.async.jobs.jobrows.DefaultJobStatus

All Implemented Interfaces:

JobStatus, Serializable, Comparable<DefaultJobStatus>

public enum DefaultJobStatus
extends Enum<DefaultJobStatus>
implements JobStatus

Provides an enumeration of the standard job statuses that Bard supports.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELED
FAILURE
PENDING
SUCCESS

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns a human-friendly description of the status.
String	getName() Returns a human-friendly name of the status.
static DefaultJobStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static DefaultJobStatus[]	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

PENDING

public static final DefaultJobStatus PENDING

SUCCESS

public static final DefaultJobStatus SUCCESS

CANCELED

public static final DefaultJobStatus CANCELED

FAILURE

public static final DefaultJobStatus FAILURE

Method Detail

values

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

Returns:

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

valueOf

public static DefaultJobStatus 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

getDescription

public String getDescription()

Description copied from interface: JobStatus

Returns a human-friendly description of the status.

Specified by:

getDescription in interface JobStatus

Returns:

A description of the status

getName

public String getName()

Description copied from interface: JobStatus

Returns a human-friendly name of the status.

Specified by:

getName in interface JobStatus

Returns:

The name of the status