Package org.jenkinsci.plugins.workflow.cps

Class DSL

java.lang.Object

groovy.lang.GroovyObjectSupport

org.jenkinsci.plugins.workflow.cps.DSL

All Implemented Interfaces:

groovy.lang.GroovyObject, Serializable

public class DSL
extends groovy.lang.GroovyObjectSupport
implements Serializable

Calls Steps and other DSL objects.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	UNSAFE_GROOVY_INTERPOLATION

Constructor Summary

Constructors

Constructor	Description
DSL(org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner handle)

Method Summary

Modifier and Type	Method	Description
protected Object	invokeDescribable(String symbol, Object _args)	When invokeMethod(String, Object) is calling a generic Descriptor
Object	invokeMethod(String name, Object args)	Executes the Step implementation specified by the name argument.
protected Object	invokeStep(org.jenkinsci.plugins.workflow.steps.StepDescriptor d, Object args)	Deprecated. Prefer invokeStep(StepDescriptor, String, Object)
protected Object	invokeStep(org.jenkinsci.plugins.workflow.steps.StepDescriptor d, String name, Object args)	When invokeMethod(String, Object) is calling a StepDescriptor
static boolean	isKeepStepArguments()	Tell us if we should store Step arguments in an ArgumentsAction or simply discard them (if set to false, explicitly)
protected Object	readResolve()

Methods inherited from class groovy.lang.GroovyObjectSupport

getMetaClass, getProperty, setMetaClass, setProperty

Methods inherited from class java.lang.Object

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

Field Detail

UNSAFE_GROOVY_INTERPOLATION

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static String UNSAFE_GROOVY_INTERPOLATION

Constructor Detail

DSL

public DSL(org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner handle)

Method Detail

readResolve

protected Object readResolve()
                      throws IOException

Throws:

IOException

isKeepStepArguments

public static boolean isKeepStepArguments()

Tell us if we should store Step arguments in an ArgumentsAction or simply discard them (if set to false, explicitly)

invokeMethod

public Object invokeMethod(String name,
                           Object args)

Executes the Step implementation specified by the name argument.

Specified by:

invokeMethod in interface groovy.lang.GroovyObject

Overrides:

invokeMethod in class groovy.lang.GroovyObjectSupport

Returns:

If the step completes execution synchronously, the result will be returned. Otherwise this method suspends.

invokeStep

@Deprecated
protected Object invokeStep(org.jenkinsci.plugins.workflow.steps.StepDescriptor d,
                            Object args)

Deprecated.

Prefer invokeStep(StepDescriptor, String, Object)

When invokeMethod(String, Object) is calling a StepDescriptor

invokeStep

protected Object invokeStep(org.jenkinsci.plugins.workflow.steps.StepDescriptor d,
                            String name,
                            Object args)

When invokeMethod(String, Object) is calling a StepDescriptor

Parameters:

d - The StepDescriptor being invoked.

name - The name used to invoke the step. May be StepDescriptor.getFunctionName(), a symbol as in StepDescriptor.metaStepsOf(java.lang.String), or d.clazz.getName().

args - The arguments passed to the step.

invokeDescribable

protected Object invokeDescribable(String symbol,
                                   Object _args)

When invokeMethod(String, Object) is calling a generic Descriptor