Class ParamsVariable
- java.lang.Object
-
- org.jenkinsci.plugins.workflow.cps.GlobalVariable
-
- org.jenkinsci.plugins.workflow.cps.ParamsVariable
-
- All Implemented Interfaces:
ExtensionPoint
@Extension public class ParamsVariable extends GlobalVariable
Allows access toParametersAction
.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Field Summary
-
Fields inherited from class org.jenkinsci.plugins.workflow.cps.GlobalVariable
ALL
-
-
Constructor Summary
Constructors Constructor Description ParamsVariable()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getName()
Defines the name of the variable.Object
getValue(CpsScript script)
Gets or creates the singleton value of the variable.-
Methods inherited from class org.jenkinsci.plugins.workflow.cps.GlobalVariable
byName, forJob, forRun
-
-
-
-
Method Detail
-
getName
public String getName()
Description copied from class:GlobalVariable
Defines the name of the variable.- Specified by:
getName
in classGlobalVariable
- Returns:
- a Java identifier
-
getValue
public Object getValue(CpsScript script) throws Exception
Description copied from class:GlobalVariable
Gets or creates the singleton value of the variable. If the object is stateful, and the state should not be managed externally (such as with aRunAction2
), then the implementation is responsible for saving it in theScript.getBinding()
.- Specified by:
getValue
in classGlobalVariable
- Parameters:
script
- the script we are running- Returns:
- a POJO or
GroovyObject
- Throws:
Exception
- if there was any problem creating it (will be thrown up to the script)- See Also:
CpsScript.getProperty(java.lang.String)
-
-