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

Class ModelASTWhen

java.lang.Object

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

org.jenkinsci.plugins.pipeline.modeldefinition.ast.ModelASTWhen

All Implemented Interfaces:

ModelASTMarkerInterface

Direct Known Subclasses:

InvisibleWhen

public class ModelASTWhen
extends ModelASTElement

If ModelASTStage will be executed or not.

Constructor Summary

Constructors

Constructor	Description
ModelASTWhen(Object sourceLocation)

Method Summary

Modifier and Type	Method	Description
Boolean	getBeforeAgent()
Boolean	getBeforeInput()
Boolean	getBeforeOptions()
List<ModelASTWhenContent>	getConditions()
void	removeSourceLocation()	Removes the source location value from this element.
void	setBeforeAgent(Boolean beforeAgent)
void	setBeforeInput(Boolean beforeInput)
void	setBeforeOptions(Boolean beforeOptions)
void	setConditions(List<ModelASTWhenContent> conditions)
String	toGroovy()	Translates this element and any children it may have into Pipeline Config-formatted Groovy, without any indentations.
Object	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

equals, getSourceLocation, hashCode, 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

ModelASTWhen

public ModelASTWhen(Object sourceLocation)

Method Detail

getConditions

public List<ModelASTWhenContent> getConditions()

setConditions

public void setConditions(List<ModelASTWhenContent> conditions)

getBeforeAgent

public Boolean getBeforeAgent()

setBeforeAgent

public void setBeforeAgent(Boolean beforeAgent)

getBeforeInput

public Boolean getBeforeInput()

setBeforeInput

public void setBeforeInput(Boolean beforeInput)

getBeforeOptions

public Boolean getBeforeOptions()

setBeforeOptions

public void setBeforeOptions(Boolean beforeOptions)

toJSON

@NonNull
public Object 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.

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

toString

public String toString()

Description copied from class: ModelASTElement

Overrides:

toString in class ModelASTElement

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.