Package hudson.model
Class RunParameterValue
java.lang.Object
hudson.model.ParameterValue
hudson.model.RunParameterValue
- All Implemented Interfaces:
Serializable
- See Also:
-
Field Summary
Fields inherited from class hudson.model.ParameterValue
name
-
Constructor Summary
ConstructorDescriptionRunParameterValue
(String name, String runId) RunParameterValue
(String name, String runId, String description) -
Method Summary
Modifier and TypeMethodDescriptionvoid
buildEnvironment
(Run<?, ?> build, EnvVars env) Exposes the name/value as an environment variable.getRun()
Can be null if theRun
that this was pointing to no longer exists.getRunId()
Computes a human-readable possible-localized one-line description of the parameter value.getValue()
Returns the most natural Java object that represents the actual value, like boolean, string, etc.toString()
Methods inherited from class hudson.model.ParameterValue
buildEnvVars, buildEnvVars, createBuildWrapper, createVariableResolver, equals, getAssignedLabel, getDefinition, getDescription, getFormattedDescription, getName, hashCode, isSensitive, setDescription
-
Constructor Details
-
RunParameterValue
-
RunParameterValue
-
-
Method Details
-
getRun
Can be null if theRun
that this was pointing to no longer exists. -
getRunId
-
getJobName
-
getNumber
-
getValue
Description copied from class:ParameterValue
Returns the most natural Java object that represents the actual value, like boolean, string, etc.- Overrides:
getValue
in classParameterValue
- Returns:
- if there is no natural value for this parameter type,
this
may be used;null
may be used when the value is normally defined but missing in this case for various reasons
-
buildEnvironment
Exposes the name/value as an environment variable.- Overrides:
buildEnvironment
in classParameterValue
- Parameters:
build
- The build for which this parameter is being used. Never null.env
- never null.
-
toString
-
getShortDescription
Description copied from class:ParameterValue
Computes a human-readable possible-localized one-line description of the parameter value.This message is used as a tooltip to describe jobs in the queue. The text should be one line without new line. No HTML allowed (the caller will perform necessary HTML escapes, so any text can be returned.)
- Overrides:
getShortDescription
in classParameterValue
-