Package jenkins.model

Class CauseOfInterruption

java.lang.Object

jenkins.model.CauseOfInterruption

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CauseOfInterruption.UserInterruption

@ExportedBean
public abstract class CauseOfInterruption
extends Object
implements Serializable

Records why an executor is interrupted.

View

summary.groovy/.jelly should do one-line HTML rendering to be used while rendering "build history" widget, next to the blocking build. By default it simply renders getShortDescription() text.

Value equality semantics

Two CauseOfInterruptions that are equal will get merged together.

Persistence

The implementation should be serializable both in Java serialization and XStream.

Since:

1.425

Author:

Kohsuke Kawaguchi

See Also:

• Executor.interrupt(Result, CauseOfInterruption...)
• InterruptedBuildAction
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CauseOfInterruption.UserInterruption	Indicates that the build was interrupted from UI.

Constructor Summary

Constructors

Constructor	Description
CauseOfInterruption()

Method Summary

Modifier and Type	Method	Description
abstract String	getShortDescription()	Human readable description of why the build is cancelled.
void	print(TaskListener listener)	Report a line to the listener about this cause.

Methods inherited from class java.lang.Object

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

Constructor Details

CauseOfInterruption

public CauseOfInterruption()

Method Details

getShortDescription

@Exported
public abstract String getShortDescription()

Human readable description of why the build is cancelled.

print

public void print(TaskListener listener)

Report a line to the listener about this cause.