com.ace.moab.api.jobs
Enum QueueStatus

java.lang.Object
  java.lang.Enum<QueueStatus>
      com.ace.moab.api.jobs.QueueStatus

All Implemented Interfaces:

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

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

This enumeration describes every queue status that a job state can belong to. A job state is defined in the enum JobState.

Author:

bkimball

Enum Constant Summary

ACTIVE
A job is actively running in a queue.

BLOCKED
A job has been blocked because of policy violation or resource requirements cannot be met.

COMPLETED
A job has completed running.

ELIGIBLE
A job is eligible to run, but has not started yet.

UNKNOWN
A job's state type is unknown.s

Method Summary

static QueueStatus	parseString(java.lang.String string) Parse a string and converts it into a corresponding QueueStatus enum value.
java.lang.String	toString()
static QueueStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static QueueStatus[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ACTIVE

public static final QueueStatus ACTIVE

A job is actively running in a queue.

BLOCKED

public static final QueueStatus BLOCKED

A job has been blocked because of policy violation or resource requirements cannot be met.

COMPLETED

public static final QueueStatus COMPLETED

A job has completed running.

ELIGIBLE

public static final QueueStatus ELIGIBLE

A job is eligible to run, but has not started yet.

UNKNOWN

public static final QueueStatus UNKNOWN

A job's state type is unknown.s

Method Detail

values

public static final QueueStatus[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(QueueStatus c : QueueStatus.values())
        System.out.println(c);

Returns:

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

valueOf

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<QueueStatus>

parseString

public static QueueStatus parseString(java.lang.String string)
                               throws java.text.ParseException

Parse a string and converts it into a corresponding QueueStatus enum value.

Parameters:

string - the string to parse.

Returns:

a corresponding QueueStatus enum value.

Throws:

java.text.ParseException - thrown if the String does not match any QueueStatus value.