public class StringParameterValue extends ParameterValue
ParameterValue
created from StringParameterDefinition
.Modifier and Type | Field and Description |
---|---|
String |
value |
name
Constructor and Description |
---|
StringParameterValue(String name,
String value) |
StringParameterValue(String name,
String value,
String description) |
Modifier and Type | Method and Description |
---|---|
void |
buildEnvironment(Run<?,?> build,
EnvVars env)
Exposes the name/value as an environment variable.
|
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. |
void |
doTrim()
Trimming for value
|
boolean |
equals(Object obj) |
String |
getShortDescription()
Computes a human-readable possible-localized one-line description of the parameter value.
|
String |
getValue()
Returns the most natural Java object that represents the actual value, like
boolean, string, etc.
|
int |
hashCode() |
String |
toString() |
buildEnvVars, buildEnvVars, createBuildWrapper, getAssignedLabel, getDefinition, getDescription, getFormattedDescription, getName, isSensitive, setDescription
@Exported(visibility=4) @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class) public String value
public void buildEnvironment(Run<?,?> build, EnvVars env)
buildEnvironment
in class ParameterValue
build
- The build for which this parameter is being used. Never null.env
- never null.public VariableResolver<String> createVariableResolver(AbstractBuild<?,?> build)
ParameterValue
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.
createVariableResolver
in class ParameterValue
build
- The build for which this parameter is being used. Never null.VariableResolver.NONE
.public String getValue()
ParameterValue
getValue
in class ParameterValue
this
may be used;
null
may be used when the value is normally defined but missing in this case for various reasonspublic void doTrim()
public int hashCode()
hashCode
in class ParameterValue
public boolean equals(Object obj)
equals
in class ParameterValue
public String getShortDescription()
ParameterValue
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.)
getShortDescription
in class ParameterValue
Copyright © 2004–2019. All rights reserved.