Class ModelASTStep
- java.lang.Object
-
- org.jenkinsci.plugins.pipeline.modeldefinition.ast.ModelASTElement
-
- org.jenkinsci.plugins.pipeline.modeldefinition.ast.ModelASTStep
-
- All Implemented Interfaces:
ModelASTMarkerInterface
- Direct Known Subclasses:
AbstractModelASTCodeBlock
,ModelASTTreeStep
public class ModelASTStep extends ModelASTElement
Represents an individual step within any of the various blocks that can contain steps.- Author:
- Kohsuke Kawaguchi, Andrew Bayer
-
-
Constructor Summary
Constructors Constructor Description ModelASTStep(Object sourceLocation)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static Map<String,String>
blockedStepsBase()
Deprecated.since 1.2-beta-4boolean
equals(Object o)
ModelASTArgumentList
getArgs()
static Map<String,String>
getBlockedSteps()
Deprecated.since 1.2-beta-4String
getName()
int
hashCode()
void
removeSourceLocation()
Removes the source location value from this element.void
setArgs(ModelASTArgumentList args)
void
setName(String name)
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
-
-
-
-
Constructor Detail
-
ModelASTStep
public ModelASTStep(Object sourceLocation)
-
-
Method Detail
-
blockedStepsBase
@Deprecated @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static Map<String,String> blockedStepsBase()
Deprecated.since 1.2-beta-4
-
getBlockedSteps
@Deprecated @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static Map<String,String> getBlockedSteps()
Deprecated.since 1.2-beta-4Useorg.jenkinsci.plugins.pipeline.modeldefinition.validator.BlockedStepsAndMethodCalls.blockedInSteps()
instead.
-
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 interfaceModelASTMarkerInterface
- Specified by:
toJSON
in classModelASTElement
- Returns:
- Generally a
JSONObject
orJSONArray
but for some leaf nodes, may be aString
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 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
-
getName
public String getName()
-
setName
public void setName(String name)
-
getArgs
public ModelASTArgumentList getArgs()
-
setArgs
public void setArgs(ModelASTArgumentList args)
-
toString
public String toString()
Description copied from class:ModelASTElement
- Overrides:
toString
in classModelASTElement
-
equals
public boolean equals(Object o)
Description copied from class:ModelASTElement
- Overrides:
equals
in classModelASTElement
-
hashCode
public int hashCode()
Description copied from class:ModelASTElement
- Overrides:
hashCode
in classModelASTElement
-
-