org.jenkinsci.plugins.pipeline.modeldefinition.ast

Class ModelASTPipelineDef

java.lang.Object

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

org.jenkinsci.plugins.pipeline.modeldefinition.ast.ModelASTPipelineDef

All Implemented Interfaces:

ModelASTMarkerInterface

public final class ModelASTPipelineDef
extends ModelASTElement

Represents the parsed pipeline definition for visual pipeline editor. Corresponds to Root.

Author:

Kohsuke Kawaguchi, Andrew Bayer

Constructor Summary

Constructors

Constructor and Description
ModelASTPipelineDef(Object sourceLocation)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ModelASTAgent	getAgent()
ModelASTEnvironment	getEnvironment()
ModelASTLibraries	getLibraries()
ModelASTOptions	getOptions()
ModelASTBuildParameters	getParameters()
ModelASTPostBuild	getPostBuild()
ModelASTStages	getStages()
ModelASTTools	getTools()
ModelASTTriggers	getTriggers()
int	hashCode()
void	removeSourceLocation() Removes the source location value from this element.
void	setAgent(ModelASTAgent agent)
void	setEnvironment(ModelASTEnvironment environment)
void	setLibraries(ModelASTLibraries libraries)
void	setOptions(ModelASTOptions options)
void	setParameters(ModelASTBuildParameters parameters)
void	setPostBuild(ModelASTPostBuild postBuild)
void	setStages(ModelASTStages stages)
void	setTools(ModelASTTools tools)
void	setTriggers(ModelASTTriggers triggers)
String	toGroovy() Translates this element and any children it may have into Pipeline Config-formatted Groovy, without any indentations.
static String	toIndentedGroovy(String orig)
net.sf.json.JSONObject	toJSON() Translates this element and any children it may have into JSON conforming to the schema.
String	toPrettyGroovy() Helper method to pretty-print the generated Groovy from this and its children.
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, 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 Detail

ModelASTPipelineDef

public ModelASTPipelineDef(Object sourceLocation)

Method Detail

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

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(@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 ModelASTElement

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

Specified by:

toGroovy in class ModelASTElement

Returns:

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

toPrettyGroovy

public String toPrettyGroovy()

Helper method to pretty-print the generated Groovy from this and its children.

Returns:

An indented string of Groovy, suitable for use in a Jenkinsfile.

toIndentedGroovy

public static String toIndentedGroovy(@NonNull
                                      String orig)

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 ModelASTElement

getStages

public ModelASTStages getStages()

setStages

public void setStages(ModelASTStages stages)

getLibraries

public ModelASTLibraries getLibraries()

setLibraries

public void setLibraries(ModelASTLibraries libraries)

getPostBuild

public ModelASTPostBuild getPostBuild()

setPostBuild

public void setPostBuild(ModelASTPostBuild postBuild)

getEnvironment

public ModelASTEnvironment getEnvironment()

setEnvironment

public void setEnvironment(ModelASTEnvironment environment)

getAgent

public ModelASTAgent getAgent()

setAgent

public void setAgent(ModelASTAgent agent)

getTools

public ModelASTTools getTools()

setTools

public void setTools(ModelASTTools tools)

getOptions

public ModelASTOptions getOptions()

setOptions

public void setOptions(ModelASTOptions options)

getParameters

public ModelASTBuildParameters getParameters()

setParameters

public void setParameters(ModelASTBuildParameters parameters)

getTriggers

public ModelASTTriggers getTriggers()

setTriggers

public void setTriggers(ModelASTTriggers triggers)

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