public abstract class BodyExecution extends Object implements Future<Object>, Serializable
Step
.
As a representation of asynchronous computation, this object implements Future
,
so that you can cancel the execution, install a listener, etc.
BodyInvoker.start()
,
Serialized FormConstructor and Description |
---|
BodyExecution() |
Modifier and Type | Method and Description |
---|---|
boolean |
cancel(boolean b)
Deprecated.
Use other overloaded forms of the cancel method to provide richer context.
|
abstract boolean |
cancel(jenkins.model.CauseOfInterruption... causes)
Attempts to cancel an executing body block.
|
boolean |
cancel(Throwable t)
Convenience method around
cancel(CauseOfInterruption...) in case
the cause is a random exception. |
abstract Collection<StepExecution> |
getCurrentExecutions()
Returns the inner-most
StepExecution s that are currently executing. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
get, get, isCancelled, isDone
public abstract Collection<StepExecution> getCurrentExecutions()
StepExecution
s that are currently executing.public abstract boolean cancel(jenkins.model.CauseOfInterruption... causes)
If the body has finished executing, or is cancelled already, the attempt will fail. This method is asynchronous. There's no guarantee that the cancellation has happened or completed before this method returns.
public boolean cancel(boolean b)
public boolean cancel(Throwable t)
cancel(CauseOfInterruption...)
in case
the cause is a random exception.Copyright © 2016–2017. All rights reserved.