Package org.jenkinsci.plugins.workflow.steps

Class AbstractStepImpl

java.lang.Object

hudson.model.AbstractDescribableImpl<Step>

org.jenkinsci.plugins.workflow.steps.Step

org.jenkinsci.plugins.workflow.steps.AbstractStepImpl

All Implemented Interfaces:

ExtensionPoint, Describable<Step>

public abstract class AbstractStepImpl
extends Step

Partial convenient step implementation. Used with AbstractStepDescriptorImpl and AbstractStepExecutionImpl.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractStepImpl()	Deprecated. Directly extend Step and avoid Guice.
protected	AbstractStepImpl(boolean ignored)	Constructor for compatibility.

Method Summary

Modifier and Type	Method	Description
protected static com.google.inject.Injector	prepareInjector(StepContext context, Step step)	Creates an Injector that performs injection to Inject and StepContextParameter.
StepExecution	start(StepContext context)	Constructs a step execution automatically according to AbstractStepDescriptorImpl.getExecutionType().

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

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractStepImpl

@Deprecated
protected AbstractStepImpl()

Deprecated.

Directly extend Step and avoid Guice. Or see AbstractStepImpl(boolean) for an existing step.

AbstractStepImpl

protected AbstractStepImpl(boolean ignored)

Constructor for compatibility. Retain this constructor and override start(org.jenkinsci.plugins.workflow.steps.StepContext) if your step historically extended AbstractStepImpl, and your AbstractStepExecutionImpl kept a non-transient reference to the AbstractStepImpl, for serial form compatibility. For new steps, extend Step directly.

Parameters:

ignored - ignored, just to differentiate this constructor from AbstractStepImpl() as a marker that the supertype must be retained

Method Detail

start

public StepExecution start(StepContext context)
                    throws Exception

Constructs a step execution automatically according to AbstractStepDescriptorImpl.getExecutionType().

Specified by:

start in class Step

Returns:

true if the execution of this step has synchronously completed before this method returns. It is the callee's responsibility to set the return value via StepContext.onSuccess(Object) or FutureCallback.onFailure(Throwable). false if the asynchronous execution has started and that StepContext will be notified when the result comes in. (Note that the nature of asynchrony is such that it is possible for the StepContext to be already notified before this method returns.)

Throws:

Exception - if any exception is thrown, Step is assumed to have completed abnormally synchronously (as if FutureCallback.onFailure(java.lang.Throwable) is called and the method returned true.)

prepareInjector

protected static com.google.inject.Injector prepareInjector(StepContext context,
                                                            @Nullable
                                                            Step step)

Creates an Injector that performs injection to Inject and StepContextParameter.