org.jenkinsci.plugins.pipeline.modeldefinition.ast

Class ModelASTElement

java.lang.Object

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

Direct Known Subclasses:

ModelASTAgent, ModelASTArgumentList, ModelASTBranch, ModelASTBuildCondition, ModelASTBuildConditionsContainer, ModelASTBuildParameters, ModelASTClosureMap, ModelASTEnvironment, ModelASTKey, ModelASTKeyValueOrMethodCallPair, ModelASTMethodCall, ModelASTOptions, ModelASTPipelineDef, ModelASTStage, ModelASTStages, ModelASTStep, ModelASTTools, ModelASTTriggers, ModelASTValue, ModelASTWhen

public abstract class ModelASTElement
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
Object	getSourceLocation()
int	hashCode()
void	removeSourceLocation() Removes the source location value from this element.
void	setSourceLocation(Object sourceLocation)
abstract String	toGroovy() Translates this element and any children it may have into Pipeline Config-formatted Groovy, without any indentations.
abstract 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 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getSourceLocation

public Object getSourceLocation()

setSourceLocation

public void setSourceLocation(Object sourceLocation)

toJSON

public abstract Object toJSON()

Translates this element and any children it may have into JSON conforming to the schema.

Returns:

Generally a JSONObject or JSONArray but for some leaf nodes, may be a String or other simple class.

toGroovy

public abstract String toGroovy()

Translates this element and any children it may have into Pipeline Config-formatted Groovy, without any indentations.

Returns:

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

validate

public void validate(@Nonnull
            ModelValidator validator)

Called to do whatever validation is necessary for this element. Overridden in most cases.

Parameters:

validator - A ModelValidator to use for more complicated validation.

removeSourceLocation

public void removeSourceLocation()

Removes the source location value from this element.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object