Package org.jenkinsci.plugins.workflow.support

Class DefaultStepContext

java.lang.Object

org.jenkinsci.plugins.workflow.steps.StepContext

org.jenkinsci.plugins.workflow.support.DefaultStepContext

All Implemented Interfaces:

com.google.common.util.concurrent.FutureCallback<Object>, Serializable

public abstract class DefaultStepContext
extends org.jenkinsci.plugins.workflow.steps.StepContext

Partial implementation of step context.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultStepContext()

Method Summary

Modifier and Type	Method	Description
protected abstract <T> T	doGet(Class<T> key)	The actual logic of get(java.lang.Class<T>), such as retrieving overrides passed to StepContext.newBodyInvoker().
final <T> T	get(Class<T> key)	Uses doGet(java.lang.Class<T>) but automatically translates certain kinds of objects into others.
protected abstract org.jenkinsci.plugins.workflow.flow.FlowExecution	getExecution()	Finds the associated execution.
protected abstract org.jenkinsci.plugins.workflow.graph.FlowNode	getNode()	Finds the associated node.

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

equals, hasBody, hashCode, isReady, newBodyInvoker, onSuccess, saveState, setResult

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.util.concurrent.FutureCallback

onFailure

Constructor Details

DefaultStepContext

public DefaultStepContext()

Method Details

get

public final <T> T get(Class<T> key)
                throws IOException,
InterruptedException

Uses doGet(java.lang.Class<T>) but automatically translates certain kinds of objects into others.

Note that some basic types are handled directly by get(java.lang.Class<T>) and cannot be overridden, such as Run, Job, FlowExecution, FlowNode and StepDescriptor.

Specified by:

get in class org.jenkinsci.plugins.workflow.steps.StepContext

Throws:

IOException

InterruptedException

doGet

@CheckForNull
protected abstract <T> T doGet(Class<T> key)
                        throws IOException,
InterruptedException

The actual logic of get(java.lang.Class<T>), such as retrieving overrides passed to StepContext.newBodyInvoker().

Throws:

IOException

InterruptedException

getExecution

@NonNull
protected abstract org.jenkinsci.plugins.workflow.flow.FlowExecution getExecution()
                                                                           throws IOException

Finds the associated execution. Automatically available from get(java.lang.Class<T>).

Throws:

IOException

getNode

@NonNull
protected abstract org.jenkinsci.plugins.workflow.graph.FlowNode getNode()
                                                                  throws IOException

Finds the associated node. Automatically available from get(java.lang.Class<T>).

Throws:

IOException