org.jenkinsci.plugins.pipeline.modeldefinition.ast

Class ModelASTStage

java.lang.Object

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

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

public final class ModelASTStage
extends ModelASTElement

Represents an individual Stage and the ModelASTBranchs it may contain.

Author:

Kohsuke Kawaguchi, Andrew Bayer

See Also:

ModelASTPipelineDef

Field Summary

Fields

Modifier and Type	Field and Description
protected ModelASTAgent	agent
protected ModelASTEnvironment	environment
protected String	name
protected ModelASTPostStage	post
protected ModelASTTools	tools
protected ModelASTWhen	when

Constructor Summary

Constructors

Constructor and Description
ModelASTStage(Object sourceLocation)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ModelASTAgent	getAgent()
List<ModelASTBranch>	getBranches()
ModelASTEnvironment	getEnvironment()
Boolean	getFailFast()
ModelASTStageInput	getInput()
String	getName()
ModelASTOptions	getOptions()
ModelASTParallel	getParallel()
List<ModelASTStage>	getParallelContent() Deprecated.
ModelASTPostStage	getPost()
ModelASTStages	getStages()
ModelASTTools	getTools()
ModelASTWhen	getWhen()
int	hashCode()
protected Object	readResolve()
void	removeSourceLocation() Removes the source location value from this element.
void	setAgent(ModelASTAgent agent)
void	setBranches(List<ModelASTBranch> branches)
void	setEnvironment(ModelASTEnvironment environment)
void	setFailFast(Boolean f)
void	setInput(ModelASTStageInput input)
void	setName(String name)
void	setOptions(ModelASTOptions options)
void	setParallel(ModelASTParallel s)
void	setParallelContent(List<ModelASTStage> parallelContent) Deprecated.
void	setPost(ModelASTPostStage post)
void	setStages(ModelASTStages stages)
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.
void	validate(ModelValidator validator, boolean isWithinParallel)

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

Field Detail

name

protected String name

agent

protected ModelASTAgent agent

post

protected ModelASTPostStage post

when

protected ModelASTWhen when

tools

protected ModelASTTools tools

environment

protected ModelASTEnvironment environment

Constructor Detail

ModelASTStage

public ModelASTStage(Object sourceLocation)

Method Detail

readResolve

protected Object readResolve()
                      throws IOException

Throws:

IOException

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(@Nonnull
                     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.

validate

public void validate(ModelValidator validator,
                     boolean isWithinParallel)

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)

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)

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)

getOptions

public ModelASTOptions getOptions()

setOptions

public void setOptions(ModelASTOptions options)

getInput

public ModelASTStageInput getInput()

setInput

public void setInput(ModelASTStageInput input)

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 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