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

Class ModelASTStage

java.lang.Object

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

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

org.jenkinsci.plugins.pipeline.modeldefinition.ast.ModelASTStage

All Implemented Interfaces:

ModelASTMarkerInterface

public class ModelASTStage
extends ModelASTStageBase

Represents an individual Stage and the ModelASTBranchs it may contain.

Author:

Kohsuke Kawaguchi, Andrew Bayer

See Also:

• ModelASTPipelineDef

Constructor Summary

Constructors

Constructor	Description
ModelASTStage(Object sourceLocation)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
List<ModelASTBranch>	getBranches()
Boolean	getFailFast()
ModelASTMatrix	getMatrix()
String	getName()
ModelASTParallel	getParallel()
List<ModelASTStage>	getParallelContent()	Deprecated.
ModelASTStages	getStages()
int	hashCode()
protected Object	readResolve()
void	removeSourceLocation()	Removes the source location value from this element.
void	setBranches(List<ModelASTBranch> branches)
void	setFailFast(Boolean f)
void	setMatrix(ModelASTMatrix s)
void	setName(String name)
void	setParallel(ModelASTParallel s)
void	setParallelContent(List<ModelASTStage> parallelContent)	Deprecated.
void	setStages(ModelASTStages stages)
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.
void	validate(ModelValidator validator, boolean isWithinParallel)

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

getAgent, getEnvironment, getInput, getOptions, getPost, getTools, getWhen, setAgent, setEnvironment, setInput, setOptions, setPost, setTools, setWhen

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

ModelASTStage

public ModelASTStage(Object sourceLocation)

Method Details

readResolve

protected Object readResolve()
                      throws IOException

Throws:

IOException

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 ModelASTStageBase

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 ModelASTStageBase

Parameters:

validator - A ModelValidator to use for more complicated validation.

validate

public void validate(ModelValidator validator,
 boolean isWithinParallel)

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 ModelASTStageBase

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 ModelASTStageBase

getName

public String getName()

setName

public void setName(String name)

getStages

public ModelASTStages getStages()

setStages

public void setStages(ModelASTStages stages)

getBranches

public List<ModelASTBranch> getBranches()

setBranches

public void setBranches(List<ModelASTBranch> branches)

getFailFast

public Boolean getFailFast()

setFailFast

public void setFailFast(Boolean f)

getParallel

public ModelASTParallel getParallel()

setParallel

public void setParallel(ModelASTParallel s)

getMatrix

public ModelASTMatrix getMatrix()

setMatrix

public void setMatrix(ModelASTMatrix s)

getParallelContent

@Deprecated
public List<ModelASTStage> getParallelContent()

Deprecated.

setParallelContent

@Deprecated
public void setParallelContent(List<ModelASTStage> parallelContent)

Deprecated.

toString

public String toString()

Description copied from class: ModelASTElement

Overrides:

toString in class ModelASTStageBase

equals

public boolean equals(Object o)

Description copied from class: ModelASTElement

Overrides:

equals in class ModelASTStageBase

hashCode

public int hashCode()

Description copied from class: ModelASTElement

Overrides:

hashCode in class ModelASTStageBase