Package hudson.model
Class BooleanParameterValue
java.lang.Object
hudson.model.ParameterValue
hudson.model.BooleanParameterValue
- All Implemented Interfaces:
Serializable
ParameterValue
created from BooleanParameterDefinition
.- See Also:
-
Field Summary
Fields inherited from class hudson.model.ParameterValue
name
-
Constructor Summary
ConstructorDescriptionBooleanParameterValue
(String name, boolean value) BooleanParameterValue
(String name, boolean value, String description) -
Method Summary
Modifier and TypeMethodDescriptionvoid
buildEnvironment
(Run<?, ?> build, EnvVars env) Exposes the name/value as an environment variable.createVariableResolver
(AbstractBuild<?, ?> build) Returns aVariableResolver
so that other components likeBuilder
s can perform variable substitution to reflect parameter values into the build process.boolean
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.int
hashCode()
toString()
Methods inherited from class hudson.model.ParameterValue
buildEnvVars, buildEnvVars, createBuildWrapper, getAssignedLabel, getDefinition, getDescription, getFormattedDescription, getName, isSensitive, setDescription
-
Field Details
-
value
@Exported(visibility=4) public final boolean value
-
-
Constructor Details
-
BooleanParameterValue
-
BooleanParameterValue
-
-
Method Details
-
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.
-
createVariableResolver
Description copied from class:ParameterValue
Returns aVariableResolver
so that other components likeBuilder
s can perform variable substitution to reflect parameter values into the build process.This is yet another means in which a
ParameterValue
can influence a build.- Overrides:
createVariableResolver
in classParameterValue
- Parameters:
build
- The build for which this parameter is being used. Never null.- Returns:
- if the parameter value is not interested in participating to the
variable replacement process, return
VariableResolver.NONE
.
-
equals
- Overrides:
equals
in classParameterValue
-
hashCode
public int hashCode()- Overrides:
hashCode
in classParameterValue
-
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
-