hudson.model
Class StringParameterValue

java.lang.Object
  hudson.model.ParameterValue
      hudson.model.StringParameterValue

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

TextParameterValue

public class StringParameterValue
extends ParameterValue

ParameterValue created from StringParameterDefinition.

See Also:

Serialized Form

Field Summary

String

value

Fields inherited from class hudson.model.ParameterValue

name

Constructor Summary

StringParameterValue(String name, String value)

StringParameterValue(String name, String value, String description)

Method Summary

void	buildEnvVars(AbstractBuild<?,?> build, EnvVars env) Exposes the name/value as an environment variable.
VariableResolver<String>	createVariableResolver(AbstractBuild<?,?> build) Returns a VariableResolver so that other components like Builders can perform variable substitution to reflect parameter values into the build process.
boolean	equals(Object obj)
String	getShortDescription() Computes a human-readable possible-localized one-line description of the parameter value.
int	hashCode()
String	toString()

Methods inherited from class hudson.model.ParameterValue

buildEnvVars, createBuildWrapper, getAssignedLabel, getDefinition, getDescription, getName, isSensitive, setDescription

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

value

@Exported(visibility=4)
public final String value

Constructor Detail

StringParameterValue

@DataBoundConstructor
public StringParameterValue(String name,
                                                 String value)

StringParameterValue

public StringParameterValue(String name,
                            String value,
                            String description)

Method Detail

buildEnvVars

public void buildEnvVars(AbstractBuild<?,?> build,
                         EnvVars env)

Exposes the name/value as an environment variable.

Overrides:

buildEnvVars in class ParameterValue

Parameters:

build - The build for which this parameter is being used. Never null.

env - never null.

createVariableResolver

public VariableResolver<String> createVariableResolver(AbstractBuild<?,?> build)

Description copied from class: ParameterValue

Returns a VariableResolver so that other components like Builders can perform variable substitution to reflect parameter values into the build process. ParameterValue can influence a build.

Overrides:

createVariableResolver in class ParameterValue

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.

hashCode

public int hashCode()

Overrides:

hashCode in class ParameterValue

equals

public boolean equals(Object obj)

Overrides:

equals in class ParameterValue

toString

public String toString()

Overrides:

toString in class Object

getShortDescription

public String 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 returend.)

Overrides:

getShortDescription in class ParameterValue