@ExportedBean(defaultVisibility=3) @StaplerAccessibleType public abstract class ParameterValue extends Object implements Serializable
ParameterDefinition.createValue(StaplerRequest, JSONObject)
for
a particular build (although this 'owner' build object is passed in for every method
call as a parameter so that the parameter won't have to persist it.)
Instances of ParameterValue
s are persisted into build's build.xml
through XStream (via ParametersAction
), so instances need to be persistable.
value.jelly
view contributes a UI fragment to display the parameter
values used for a build.
ParameterValue
is used to record values of the past build, but
ParameterDefinition
used back then might be gone already, or represent
a different parameter now. So don't try to use the name to infer
ParameterDefinition
is.
ParameterDefinition
,
ParametersAction
,
Serialized FormModifier | Constructor and Description |
---|---|
protected |
ParameterValue(String name) |
protected |
ParameterValue(String name,
String description) |
Modifier and Type | Method and Description |
---|---|
void |
buildEnvironment(Run<?,?> build,
EnvVars env)
Adds environmental variables for the builds to the given map.
|
void |
buildEnvVars(AbstractBuild<?,?> build,
EnvVars env)
Deprecated.
Use
buildEnvironment(Run, EnvVars) instead. |
void |
buildEnvVars(AbstractBuild<?,?> build,
Map<String,String> env)
Deprecated.
as of 1.344
Use
buildEnvironment(Run, EnvVars) instead. |
BuildWrapper |
createBuildWrapper(AbstractBuild<?,?> build)
Called at the beginning of a build (but after
SCM operations
have taken place) to let a ParameterValue contributes a
BuildWrapper to the build. |
VariableResolver<String> |
createVariableResolver(AbstractBuild<?,?> build)
Returns a
VariableResolver so that other components like Builder s
can perform variable substitution to reflect parameter values into the build process. |
boolean |
equals(Object obj) |
Label |
getAssignedLabel(SubTask task)
Controls where the build (that this parameter is submitted to) will happen.
|
ParameterDefinition |
getDefinition()
Deprecated.
since 2008-09-20.
parameter definition may change any time. So if you find yourself
in need of accessing the information from
ParameterDefinition ,
instead copy them in ParameterDefinition.createValue(StaplerRequest, JSONObject)
into ParameterValue . |
String |
getDescription() |
String |
getFormattedDescription() |
String |
getName()
Name of the parameter.
|
String |
getShortDescription()
Computes a human-readable possible-localized one-line description of the parameter value.
|
Object |
getValue()
Returns the most natural Java object that represents the actual value, like
boolean, string, etc.
|
int |
hashCode() |
boolean |
isSensitive()
Returns whether the information contained in this ParameterValue is
sensitive or security related.
|
void |
setDescription(String description) |
protected final String name
protected ParameterValue(String name)
public String getDescription()
public void setDescription(String description)
@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) public String getFormattedDescription()
@Exported public final String getName()
ParameterValue
among other parameters
for the same build. This must be the same as ParameterDefinition.getName()
.@Deprecated public void buildEnvVars(AbstractBuild<?,?> build, Map<String,String> env)
buildEnvironment(Run, EnvVars)
instead.This provides a means for a parameter to pass the parameter values to the build to be performed.
When this method is invoked, the map already contains the current "planned export" list. The implementation is expected to add more values to this map (or do nothing)
Formerly, environment variables would be by convention all upper case.
(This is so that a Windows/Unix heterogeneous environment
won't get inconsistent result depending on which platform to
execute.) But now see EnvVars
why upper casing is a bad idea.
env
- never null.build
- The build for which this parameter is being used. Never null.@Deprecated public void buildEnvVars(AbstractBuild<?,?> build, EnvVars env)
buildEnvironment(Run, EnvVars)
instead.public void buildEnvironment(Run<?,?> build, EnvVars env)
This provides a means for a parameter to pass the parameter values to the build to be performed.
When this method is invoked, the map already contains the current "planned export" list. The implementation is expected to add more values to this map (or do nothing)
env
- never null.build
- The build for which this parameter is being used. Never null.public BuildWrapper createBuildWrapper(AbstractBuild<?,?> build)
SCM
operations
have taken place) to let a ParameterValue
contributes a
BuildWrapper
to the build.
This provides a means for a parameter to perform more extensive set up / tear down during a build.
build
- The build for which this parameter is being used. Never null.BuildWrapper
to contribute to.public VariableResolver<String> createVariableResolver(AbstractBuild<?,?> build)
VariableResolver
so that other components like Builder
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.
build
- The build for which this parameter is being used. Never null.VariableResolver.NONE
.@Deprecated public ParameterDefinition getDefinition()
ParameterDefinition
,
instead copy them in ParameterDefinition.createValue(StaplerRequest, JSONObject)
into ParameterValue
.ParameterDefinition
is not a good idea.public String getShortDescription()
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.)
public boolean isSensitive()
Subclasses can override this to control the return value.
@CheckForNull public Object getValue()
this
may be used;
null
may be used when the value is normally defined but missing in this case for various reasonspublic Label getAssignedLabel(SubTask task)
AbstractProject.getAssignedLabel()
. If a build is
submitted with multiple parameters, the first one that returns non-null
from this method will win, and all others won't be consulted.Copyright © 2004–2021. All rights reserved.