Package org.jenkinsci.plugins.workflow.actions

Enum QueueItemAction.QueueState

java.lang.Object

java.lang.Enum<QueueItemAction.QueueState>

org.jenkinsci.plugins.workflow.actions.QueueItemAction.QueueState

All Implemented Interfaces:

Serializable, Comparable<QueueItemAction.QueueState>

Enclosing class:

QueueItemAction

public static enum QueueItemAction.QueueState
extends Enum<QueueItemAction.QueueState>

Possible queue states for the item associated with this FlowNode.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELLED	The Queue.Item has left the queue but no WorkspaceAction is present on the FlowNode.
LAUNCHED	The Queue.Item has actually launched, meaning it has left the queue and there is a WorkspaceAction present on the FlowNode.
QUEUED	The Queue.Item is currently in the queue.
UNKNOWN	The FlowNode has neither a QueueItemAction nor a WorkspaceAction, so its queue status cannot be determined.

Method Summary

Modifier and Type	Method	Description
static QueueItemAction.QueueState	valueOf(String name)	Returns the enum constant of this type with the specified name.
static QueueItemAction.QueueState[]	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

QUEUED

public static final QueueItemAction.QueueState QUEUED

The Queue.Item is currently in the queue.

CANCELLED

public static final QueueItemAction.QueueState CANCELLED

The Queue.Item has left the queue but no WorkspaceAction is present on the FlowNode.

LAUNCHED

public static final QueueItemAction.QueueState LAUNCHED

The Queue.Item has actually launched, meaning it has left the queue and there is a WorkspaceAction present on the FlowNode.

UNKNOWN

public static final QueueItemAction.QueueState UNKNOWN

The FlowNode has neither a QueueItemAction nor a WorkspaceAction, so its queue status cannot be determined. This may be the case if the FlowNode is not actually for a node block.

Method Detail

values

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

Returns:

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

valueOf

public static QueueItemAction.QueueState 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