org.jenkinsci.plugins.pipeline.modeldefinition.ast

Class ModelASTNamedArgumentList

java.lang.Object

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

org.jenkinsci.plugins.pipeline.modeldefinition.ast.ModelASTArgumentList

org.jenkinsci.plugins.pipeline.modeldefinition.ast.ModelASTNamedArgumentList

All Implemented Interfaces:

ModelASTMarkerInterface

public final class ModelASTNamedArgumentList
extends ModelASTArgumentList

Represents the named parameters for a step in a map of ModelASTKeys and ModelASTValues.

Author:

Kohsuke Kawaguchi, Andrew Bayer

Constructor Summary

Constructors

Constructor and Description
ModelASTNamedArgumentList(Object sourceLocation)

Method Summary

Modifier and Type	Method and Description
Map<String,?>	argListToMap()
boolean	containsKeyName(String keyName) Checks if a given key name is present.
boolean	equals(Object o)
Map<ModelASTKey,ModelASTValue>	getArguments()
int	hashCode()
ModelASTKey	keyForName(String keyName)
void	removeSourceLocation() Removes the source location value from this element.
void	setArguments(Map<ModelASTKey,ModelASTValue> arguments)
String	toGroovy() Translates this element and any children it may have into Pipeline Config-formatted Groovy, without any indentations.
net.sf.json.JSONArray	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.
ModelASTValue	valueForName(String keyName)

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

ModelASTNamedArgumentList

public ModelASTNamedArgumentList(Object sourceLocation)

Method Detail

toJSON

@NonNull
public net.sf.json.JSONArray 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.

containsKeyName

public boolean containsKeyName(@NonNull
                               String keyName)

Checks if a given key name is present.

Parameters:

keyName - The name of a key to check for.

Returns:

True if a ModelASTKey with that name is present in the map.

keyForName

public ModelASTKey keyForName(@NonNull
                              String keyName)

valueForName

public ModelASTValue valueForName(@NonNull
                                  String keyName)

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

getArguments

public Map<ModelASTKey,ModelASTValue> getArguments()

setArguments

public void setArguments(Map<ModelASTKey,ModelASTValue> arguments)

argListToMap

public Map<String,?> argListToMap()

Specified by:

argListToMap in class ModelASTArgumentList

toString

public String toString()

Description copied from class: ModelASTElement

Overrides:

toString in class ModelASTArgumentList

equals

public boolean equals(Object o)

Description copied from class: ModelASTElement

Overrides:

equals in class ModelASTArgumentList

hashCode

public int hashCode()

Description copied from class: ModelASTElement

Overrides:

hashCode in class ModelASTElement