Package org.jenkinsci.plugins.pipeline.modeldefinition.ast

Class ModelASTTreeStep

java.lang.Object

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

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

org.jenkinsci.plugins.pipeline.modeldefinition.ast.ModelASTTreeStep

All Implemented Interfaces:

ModelASTMarkerInterface

public class ModelASTTreeStep
extends ModelASTStep

Represents the special case of a step that has a sub-block of further steps within it.

Author:

Kohsuke Kawaguchi, Andrew Bayer

Constructor Summary

Constructors

Constructor	Description
ModelASTTreeStep(Object sourceLocation)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
List<ModelASTStep>	getChildren()
int	hashCode()
void	removeSourceLocation()	Removes the source location value from this element.
void	setChildren(List<ModelASTStep> children)
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.ModelASTStep

blockedStepsBase, getArgs, getBlockedSteps, getName, setArgs, setName

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

getSourceLocation, nullIfEmpty, removeSourceLocationsFrom, removeSourceLocationsFrom, removeSourceLocationsFrom, removeSourceLocationsFrom, setSourceLocation, toGroovy, toGroovy, toGroovyArgList, toGroovyArgList, toGroovyBlock, toGroovyBlock, toGroovyBlock, toGroovyCheckEmpty, toJSON, toJSONArray, toJSONArray, toJSONCheckEmpty, toJSONObject, validate, validate, validate

Methods inherited from class java.lang.Object

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

Constructor Details

ModelASTTreeStep

public ModelASTTreeStep(Object sourceLocation)

Method Details

toJSON

@NonNull
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 interface ModelASTMarkerInterface

Overrides:

toJSON in class ModelASTStep

Returns:

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

validate

public void validate(@NonNull
 ModelValidator validator)

Description copied from class: ModelASTElement

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

Specified by:

validate in interface ModelASTMarkerInterface

Overrides:

validate in class ModelASTStep

Parameters:

validator - A ModelValidator to use for more complicated validation.

toGroovy

@NonNull
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 interface ModelASTMarkerInterface

Overrides:

toGroovy in class ModelASTStep

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.

Specified by:

removeSourceLocation in interface ModelASTMarkerInterface

Overrides:

removeSourceLocation in class ModelASTStep

getChildren

public List<ModelASTStep> getChildren()

setChildren

public void setChildren(List<ModelASTStep> children)

toString

public String toString()

Description copied from class: ModelASTElement

Overrides:

toString in class ModelASTStep

equals

public boolean equals(Object o)

Description copied from class: ModelASTElement

Overrides:

equals in class ModelASTStep

hashCode

public int hashCode()

Description copied from class: ModelASTElement

Overrides:

hashCode in class ModelASTStep