Package org.jenkinsci.plugins.workflow.actions

Class QueueItemAction

java.lang.Object

hudson.model.InvisibleAction

org.jenkinsci.plugins.workflow.actions.QueueItemAction

All Implemented Interfaces:

Action, ModelObject, PersistentAction

public abstract class QueueItemAction
extends InvisibleAction
implements PersistentAction

Records information for a node block.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueueItemAction.QueueState	Possible queue states for the item associated with this FlowNode.

Constructor Summary

Constructors

Constructor	Description
QueueItemAction()

Method Summary

Modifier and Type	Method	Description
static QueueItemAction.QueueState	getNodeState(FlowNode node)	Get the current QueueItemAction.QueueState for a FlowNode.
static Queue.Item	getQueueItem(FlowNode node)
abstract Queue.Item	itemInQueue()	Gets the Queue.Item for this task, if it exists.

Methods inherited from class hudson.model.InvisibleAction

getDisplayName, getIconFileName, getUrlName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface hudson.model.Action

getDisplayName, getIconFileName, getUrlName

Constructor Detail

QueueItemAction

public QueueItemAction()

Method Detail

itemInQueue

@CheckForNull
public abstract Queue.Item itemInQueue()

Gets the Queue.Item for this task, if it exists.

Returns:

The item, or null if it's not in the queue.

getNodeState

@NonNull
public static QueueItemAction.QueueState getNodeState(@NonNull
                                                      FlowNode node)

Get the current QueueItemAction.QueueState for a FlowNode. Will return QueueItemAction.QueueState.UNKNOWN for any node without one of an QueueItemAction or WorkspaceAction.

Parameters:

node - A non-null FlowNode

Returns:

The current queue state of the flownode.

getQueueItem

@CheckForNull
public static Queue.Item getQueueItem(@NonNull
                                      FlowNode node)