org.jenkinsci.plugins.pipeline.modeldefinition.ast

Class InvisibleGlobalWhenCondition

java.lang.Object

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

org.jenkinsci.plugins.pipeline.modeldefinition.ast.ModelASTWhenCondition

org.jenkinsci.plugins.pipeline.modeldefinition.ast.InvisibleGlobalWhenCondition

All Implemented Interfaces:

ModelASTMarkerInterface, ModelASTWhenContent

public class InvisibleGlobalWhenCondition
extends ModelASTWhenCondition

Special case of a ModelASTWhenCondition generated for a globally defined when condition.

Constructor Summary

Constructors

Constructor and Description
InvisibleGlobalWhenCondition() Used to create invisible when conditions without base stage information, used for the "allOf" conditional generated when a stage already has when conditions.
InvisibleGlobalWhenCondition(String stageName, ModelASTStageBase stage) Used to create invisible when conditions with a base stage for comparison and querying.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ModelASTStageBase	getStage()
String	getStageName()
int	hashCode()
void	removeSourceLocation() Removes the source location value from this element.
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.
void	validate(ModelValidator validator) Called to do whatever validation is necessary for this element.

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

getArgs, getChildren, getName, setArgs, setChildren, setName, toString

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

InvisibleGlobalWhenCondition

public InvisibleGlobalWhenCondition()

Used to create invisible when conditions without base stage information, used for the "allOf" conditional generated when a stage already has when conditions.

InvisibleGlobalWhenCondition

public InvisibleGlobalWhenCondition(String stageName,
                                    ModelASTStageBase stage)

Used to create invisible when conditions with a base stage for comparison and querying.

Parameters:

stageName - The name of the stage this condition belongs to. Explicitly specified due to auto-generated stage names with matrices.

stage - The ModelASTStageBase for the stage this condition belongs to, for inspection.

Method Detail

getStageName

public String getStageName()

getStage

public ModelASTStageBase getStage()

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 ModelASTWhenCondition

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

Overrides:

toGroovy in class ModelASTWhenCondition

Returns:

A simple String of Groovy code for this element and its children.

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 ModelASTWhenCondition

Parameters:

validator - A ModelValidator to use for more complicated validation.

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 ModelASTWhenCondition

equals

public boolean equals(Object o)

Description copied from class: ModelASTElement

Overrides:

equals in class ModelASTWhenCondition

hashCode

public int hashCode()

Description copied from class: ModelASTElement

Overrides:

hashCode in class ModelASTWhenCondition