org.jenkinsci.plugins.pipeline.modeldefinition.ast

Class ModelASTStep

java.lang.Object

org.jenkinsci.plugins.pipeline.modeldefinition.ast.ModelASTElement

org.jenkinsci.plugins.pipeline.modeldefinition.ast.ModelASTStep

Direct Known Subclasses:

AbstractModelASTCodeBlock, ModelASTTreeStep

@ToString(includeSuper=true,
          includeSuperProperties=true)
public class ModelASTStep
extends ModelASTElement

Represents an individual step within any of the various blocks that can contain steps.

Author:

Kohsuke Kawaguchi, Andrew Bayer

Constructor Summary

Constructors

Constructor and Description
ModelASTStep(Object sourceLocation)

Method Summary

Methods

Modifier and Type	Method and Description
static Map<String,String>	blockedStepsBase()
boolean	equals(Object o)
ModelASTArgumentList	getArgs()
static Map<String,String>	getBlockedSteps() A map of step names which are banned from being executed within a step block.
String	getName()
int	hashCode()
void	removeSourceLocation() Removes the source location value from this element.
void	setArgs(ModelASTArgumentList args)
void	setName(String name)
String	toGroovy() Translates this element and any children it may have into Pipeline Config-formatted Groovy, without any indentations.
net.sf.json.JSONObject	toJSON() Translates this element and any children it may have into JSON conforming to the schema.
String	toString()
void	validate(ModelValidator validator) Called to do whatever validation is necessary for this element.

Methods inherited from class org.jenkinsci.plugins.pipeline.modeldefinition.ast.ModelASTElement

getSourceLocation, setSourceLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelASTStep

public ModelASTStep(Object sourceLocation)

Method Detail

blockedStepsBase

public static Map<String,String> blockedStepsBase()

getBlockedSteps

public static Map<String,String> getBlockedSteps()

A map of step names which are banned from being executed within a step block.

Returns:

the map of steps that are banned from being executed within a step block, keyed by step name.

toJSON

public net.sf.json.JSONObject toJSON()

Description copied from class: ModelASTElement

Translates this element and any children it may have into JSON conforming to the schema.

Specified by:

toJSON in class ModelASTElement

Returns:

Generally a JSONObject or JSONArray but for some leaf nodes, may be a String or other simple class.

validate

public void validate(ModelValidator validator)

Description copied from class: ModelASTElement

Called to do whatever validation is necessary for this element. Overridden in most cases.

Overrides:

validate in class ModelASTElement

Parameters:

validator - A ModelValidator to use for more complicated validation.

toGroovy

public String toGroovy()

Description copied from class: ModelASTElement

Translates this element and any children it may have into Pipeline Config-formatted Groovy, without any indentations.

Specified by:

toGroovy in class ModelASTElement

Returns:

A simple String of Groovy code for this element and its children.

removeSourceLocation

public void removeSourceLocation()

Description copied from class: ModelASTElement

Removes the source location value from this element.

Overrides:

removeSourceLocation in class ModelASTElement

getName

public String getName()

setName

public void setName(String name)

getArgs

public ModelASTArgumentList getArgs()

setArgs

public void setArgs(ModelASTArgumentList args)

toString

public String toString()

Description copied from class: ModelASTElement

Overrides:

toString in class ModelASTElement

equals

public boolean equals(Object o)

Description copied from class: ModelASTElement

Overrides:

equals in class ModelASTElement

hashCode

public int hashCode()

Description copied from class: ModelASTElement

Overrides:

hashCode in class ModelASTElement