Package org.jenkinsci.plugins.workflow.steps

Class GeneralNonBlockingStepExecution.TailCall

java.lang.Object

org.jenkinsci.plugins.workflow.steps.BodyExecutionCallback

org.jenkinsci.plugins.workflow.steps.GeneralNonBlockingStepExecution.TailCall

All Implemented Interfaces:

Serializable

Enclosing class:

GeneralNonBlockingStepExecution

protected abstract class GeneralNonBlockingStepExecution.TailCall
extends BodyExecutionCallback

Variant of BodyExecutionCallback.TailCall which wraps finished(org.jenkinsci.plugins.workflow.steps.StepContext) in GeneralNonBlockingStepExecution.run(org.jenkinsci.plugins.workflow.steps.GeneralNonBlockingStepExecution.Block).

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jenkinsci.plugins.workflow.steps.BodyExecutionCallback

BodyExecutionCallback.TailCall

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TailCall()

Method Summary

Modifier and Type	Method	Description
protected abstract void	finished(StepContext context)	Called when the body is finished.
void	onFailure(StepContext context, Throwable t)	Notifies that the body execution has aborted abnormally.
void	onSuccess(StepContext context, Object result)	Notifies that the body execution has completed successfully.

Methods inherited from class org.jenkinsci.plugins.workflow.steps.BodyExecutionCallback

onStart, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

TailCall

protected TailCall()

Method Detail

finished

protected abstract void finished(StepContext context)
                          throws Exception

Called when the body is finished.

Parameters:

context - the body context as passed to onSuccess(org.jenkinsci.plugins.workflow.steps.StepContext, java.lang.Object) or onFailure(org.jenkinsci.plugins.workflow.steps.StepContext, java.lang.Throwable)

Throws:

Exception - if anything is thrown here, the step fails too

onSuccess

public final void onSuccess(StepContext context,
                            Object result)

Description copied from class: BodyExecutionCallback

Notifies that the body execution has completed successfully.

StepContext given to this method lets you access objects that correspond to the end of the body, as opposed to the objects that correspond to the invocation of the step that invoked the body. Otherwise the context is identical in behaviour to that given to Step.start(StepContext).

So for example this is a good place to record any logging that's attributed to the end of the body execution.

Specified by:

onSuccess in class BodyExecutionCallback

onFailure

public final void onFailure(StepContext context,
                            Throwable t)

Description copied from class: BodyExecutionCallback

Notifies that the body execution has aborted abnormally.

See BodyExecutionCallback.onSuccess(StepContext, Object) for the discussion of how the given StepContext behaves.

Specified by:

onFailure in class BodyExecutionCallback