org.jenkinsci.plugins.pipeline.modeldefinition.ast

Class ModelASTStageBase

java.lang.Object

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

org.jenkinsci.plugins.pipeline.modeldefinition.ast.ModelASTStageBase

All Implemented Interfaces:

ModelASTMarkerInterface

Direct Known Subclasses:

ModelASTMatrix, ModelASTStage

public abstract class ModelASTStageBase
extends ModelASTElement

Represents an individual Stage and the ModelASTBranchs it may contain.

Author:

Kohsuke Kawaguchi, Andrew Bayer

See Also:

ModelASTPipelineDef

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModelASTStageBase(Object sourceLocation)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ModelASTAgent	getAgent()
ModelASTEnvironment	getEnvironment()
ModelASTStageInput	getInput()
ModelASTOptions	getOptions()
ModelASTPostStage	getPost()
ModelASTTools	getTools()
ModelASTWhen	getWhen()
int	hashCode()
void	removeSourceLocation() Removes the source location value from this element.
void	setAgent(ModelASTAgent agent)
void	setEnvironment(ModelASTEnvironment environment)
void	setInput(ModelASTStageInput input)
void	setOptions(ModelASTOptions options)
void	setPost(ModelASTPostStage post)
void	setTools(ModelASTTools tools)
void	setWhen(ModelASTWhen when)
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, 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

ModelASTStageBase

protected ModelASTStageBase(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.

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

getAgent

public ModelASTAgent getAgent()

setAgent

public void setAgent(ModelASTAgent agent)

getPost

public ModelASTPostStage getPost()

setPost

public void setPost(ModelASTPostStage post)

getWhen

public ModelASTWhen getWhen()

setWhen

public void setWhen(ModelASTWhen when)

getTools

public ModelASTTools getTools()

setTools

public void setTools(ModelASTTools tools)

getEnvironment

public ModelASTEnvironment getEnvironment()

setEnvironment

public void setEnvironment(ModelASTEnvironment environment)

getOptions

public ModelASTOptions getOptions()

setOptions

public void setOptions(ModelASTOptions options)

getInput

public ModelASTStageInput getInput()

setInput

public void setInput(ModelASTStageInput input)

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