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 ofModelASTKey
s andModelASTValue
s.- Author:
- Kohsuke Kawaguchi, Andrew Bayer
-
-
Constructor Summary
Constructors Constructor Description ModelASTNamedArgumentList(Object sourceLocation)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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
-
-
-
-
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 interfaceModelASTMarkerInterface
- Specified by:
toJSON
in classModelASTElement
- Returns:
- Generally a
JSONObject
orJSONArray
but for some leaf nodes, may be aString
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 interfaceModelASTMarkerInterface
- Overrides:
validate
in classModelASTElement
- Parameters:
validator
- AModelValidator
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 interfaceModelASTMarkerInterface
- Specified by:
toGroovy
in classModelASTElement
- 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 interfaceModelASTMarkerInterface
- Overrides:
removeSourceLocation
in classModelASTElement
-
getArguments
public Map<ModelASTKey,ModelASTValue> getArguments()
-
setArguments
public void setArguments(Map<ModelASTKey,ModelASTValue> arguments)
-
argListToMap
public Map<String,?> argListToMap()
- Specified by:
argListToMap
in classModelASTArgumentList
-
toString
public String toString()
Description copied from class:ModelASTElement
- Overrides:
toString
in classModelASTArgumentList
-
equals
public boolean equals(Object o)
Description copied from class:ModelASTElement
- Overrides:
equals
in classModelASTArgumentList
-
hashCode
public int hashCode()
Description copied from class:ModelASTElement
- Overrides:
hashCode
in classModelASTElement
-
-