Package hudson.model.queue

Class CauseOfBlockage

java.lang.Object

hudson.model.queue.CauseOfBlockage

Direct Known Subclasses:

AbstractProject.BecauseOfDownstreamBuildInProgress, AbstractProject.BecauseOfUpstreamBuildInProgress, BlockedBecauseOfBuildInProgress, CauseOfBlockage.BecauseLabelIsBusy, CauseOfBlockage.BecauseLabelIsOffline, CauseOfBlockage.BecauseNodeIsBusy, CauseOfBlockage.BecauseNodeIsNotAcceptingTasks, CauseOfBlockage.BecauseNodeIsOffline, CompositeCauseOfBlockage

public abstract class CauseOfBlockage
extends Object

If something is blocked/vetoed, this object represents why.

Originally, this is added for Queue.Task stuck in the queue, but since then the use of this has expanded beyond queues.

View

summary.jelly should do one-line HTML rendering to be used showing the cause to the user. By default it simply renders getShortDescription() text.

For queues, this is used while rendering the "build history" widget.

Since:

1.330

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CauseOfBlockage.BecauseLabelIsBusy	Build is blocked because everyone that matches the specified label is fully busy
static final class	CauseOfBlockage.BecauseLabelIsOffline	Build is blocked because all the nodes that match a given label is offline.
static final class	CauseOfBlockage.BecauseNodeIsBusy	Build is blocked because a node is fully busy
static final class	CauseOfBlockage.BecauseNodeIsNotAcceptingTasks	Build is blocked because a node (or its retention strategy) is not accepting tasks.
static final class	CauseOfBlockage.BecauseNodeIsOffline	Build is blocked because a node is offline.

Constructor Summary

Constructors

Constructor	Description
CauseOfBlockage()

Method Summary

Modifier and Type	Method	Description
static CauseOfBlockage	createNeedsMoreExecutor(org.jvnet.localizer.Localizable l)
static CauseOfBlockage	fromMessage(org.jvnet.localizer.Localizable l)	Obtains a simple implementation backed by Localizable.
abstract String	getShortDescription()	Human readable description of why the build is blocked.
boolean	isFatal()
void	print(TaskListener listener)	Report a line to the listener about this cause.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

CauseOfBlockage

public CauseOfBlockage()

Method Details

getShortDescription

public abstract String getShortDescription()

Human readable description of why the build is blocked.

isFatal

public boolean isFatal()

Returns:

true if the blockage is fatal and the item should be removed from the queue.

Since:

2.532

print

public void print(TaskListener listener)

Report a line to the listener about this cause.

fromMessage

public static CauseOfBlockage fromMessage(@NonNull
 org.jvnet.localizer.Localizable l)

Obtains a simple implementation backed by Localizable.

toString

public String toString()

Overrides:

toString in class Object

createNeedsMoreExecutor

public static CauseOfBlockage createNeedsMoreExecutor(org.jvnet.localizer.Localizable l)