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

Class ModelASTMatrix

java.lang.Object

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

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

org.jenkinsci.plugins.pipeline.modeldefinition.ast.ModelASTMatrix

All Implemented Interfaces:

ModelASTMarkerInterface

public final class ModelASTMatrix
extends ModelASTStageBase

Represents the collection of Stages to be executed in the build in parallel. Corresponds to Stages. Used as a base to hold common functionality between parallel and matrix.

Author:

Liam Newman

Constructor Summary

Constructors

Constructor	Description
ModelASTMatrix(Object sourceLocation)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ModelASTAxisContainer	getAxes()
ModelASTExcludes	getExcludes()
ModelASTStages	getStages()
int	hashCode()
void	removeSourceLocation()	Removes the source location value from this element.
void	setAxes(ModelASTAxisContainer axes)
void	setExcludes(ModelASTExcludes excludes)
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.

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

ModelASTMatrix

public ModelASTMatrix(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 ModelASTStageBase

Returns:

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

validate

public void validate(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.

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

toString

public String toString()

Description copied from class: ModelASTElement

Overrides:

toString in class ModelASTStageBase

getAxes

public ModelASTAxisContainer getAxes()

setAxes

public void setAxes(ModelASTAxisContainer axes)

getExcludes

public ModelASTExcludes getExcludes()

setExcludes

public void setExcludes(ModelASTExcludes excludes)

getStages

public ModelASTStages getStages()

setStages

public void setStages(ModelASTStages stages)

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