org.jenkinsci.plugins.pipeline.modeldefinition.ast

Class ModelASTStageInput

java.lang.Object

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

org.jenkinsci.plugins.pipeline.modeldefinition.ast.ModelASTStageInput

All Implemented Interfaces:

ModelASTMarkerInterface

public final class ModelASTStageInput
extends ModelASTElement

An input step for a single stage.

Author:

Andrew Bayer

Constructor Summary

Constructors

Constructor and Description
ModelASTStageInput(Object sourceLocation)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ModelASTValue	getId()
ModelASTValue	getMessage()
ModelASTValue	getOk()
List<ModelASTBuildParameter>	getParameters()
ModelASTValue	getSubmitter()
ModelASTValue	getSubmitterParameter()
int	hashCode()
void	removeSourceLocation() Removes the source location value from this element.
void	setId(ModelASTValue id)
void	setMessage(ModelASTValue message)
void	setOk(ModelASTValue ok)
void	setParameters(List<ModelASTBuildParameter> parameters)
void	setSubmitter(ModelASTValue submitter)
void	setSubmitterParameter(ModelASTValue submitterParameter)
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.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

ModelASTStageInput

public ModelASTStageInput(Object sourceLocation)

Method Detail

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

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.

Specified by:

validate in interface ModelASTMarkerInterface

Overrides:

validate in class ModelASTElement

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

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

getParameters

public List<ModelASTBuildParameter> getParameters()

setParameters

public void setParameters(List<ModelASTBuildParameter> parameters)

getMessage

public ModelASTValue getMessage()

setMessage

public void setMessage(ModelASTValue message)

getId

public ModelASTValue getId()

setId

public void setId(ModelASTValue id)

getOk

public ModelASTValue getOk()

setOk

public void setOk(ModelASTValue ok)

getSubmitter

public ModelASTValue getSubmitter()

setSubmitter

public void setSubmitter(ModelASTValue submitter)

getSubmitterParameter

public ModelASTValue getSubmitterParameter()

setSubmitterParameter

public void setSubmitterParameter(ModelASTValue submitterParameter)

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