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

Class InvisibleWhen

java.lang.Object

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

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

org.jenkinsci.plugins.pipeline.modeldefinition.ast.InvisibleWhen

All Implemented Interfaces:

ModelASTMarkerInterface

public class InvisibleWhen
extends ModelASTWhen

when container generated when adding invisible global when conditions to a stage, containing the new invisible conditions and any explicitly defined ones. When created with existing conditions, the existing when container is stored for use as well. This is used as a marker to avoid validation, JSON/Groovy generation, etc for the generated container.

Constructor Summary

Constructors

Constructor	Description
InvisibleWhen()

Method Summary

Modifier and Type	Method	Description
Boolean	getBeforeAgent()
Boolean	getBeforeInput()
Boolean	getBeforeOptions()
Object	getSourceLocation()
void	removeSourceLocation()	Removes the source location value from this element.
void	setOriginalWhen(ModelASTWhen originalWhen)
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.ModelASTWhen

getConditions, setBeforeAgent, setBeforeInput, setBeforeOptions, setConditions

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

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

InvisibleWhen

public InvisibleWhen()

Method Detail

setOriginalWhen

public void setOriginalWhen(ModelASTWhen originalWhen)

getSourceLocation

public Object getSourceLocation()

Overrides:

getSourceLocation in class ModelASTElement

getBeforeAgent

public Boolean getBeforeAgent()

Overrides:

getBeforeAgent in class ModelASTWhen

getBeforeInput

public Boolean getBeforeInput()

Overrides:

getBeforeInput in class ModelASTWhen

getBeforeOptions

public Boolean getBeforeOptions()

Overrides:

getBeforeOptions in class ModelASTWhen

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

Overrides:

toJSON in class ModelASTWhen

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 ModelASTWhen

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 ModelASTWhen

toString

public String toString()

Description copied from class: ModelASTElement

Overrides:

toString in class ModelASTWhen

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 ModelASTWhen

Parameters:

validator - A ModelValidator to use for more complicated validation.