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

Class ModelASTAgent

java.lang.Object

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

org.jenkinsci.plugins.pipeline.modeldefinition.ast.ModelASTAgent

All Implemented Interfaces:

ModelASTMarkerInterface

public final class ModelASTAgent
extends ModelASTElement

Represents what context in which to run the build - i.e., which label to run on, what Docker agent to run in, etc. Corresponds to Agent.

Author:

Andrew Bayer

Constructor Summary

Constructors

Constructor	Description
ModelASTAgent(Object sourceLocation)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ModelASTKey	getAgentType()
ModelASTMethodArg	getVariables()
int	hashCode()
void	removeSourceLocation()	Removes the source location value from this element.
void	setAgentType(ModelASTKey k)
void	setVariables(ModelASTMethodArg variables)
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

ModelASTAgent

public ModelASTAgent(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

getAgentType

public ModelASTKey getAgentType()

setAgentType

public void setAgentType(ModelASTKey k)

getVariables

public ModelASTMethodArg getVariables()

setVariables

public void setVariables(ModelASTMethodArg variables)

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