hudson.model

Class JobParameterValue

java.lang.Object

hudson.model.ParameterValue

hudson.model.JobParameterValue

All Implemented Interfaces:

Serializable

public class JobParameterValue
extends ParameterValue

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
Job	job

Fields inherited from class hudson.model.ParameterValue

name

Constructor Summary

Constructors

Constructor and Description
JobParameterValue(String name, Job job)

Method Summary

Modifier and Type	Method and Description
void	buildEnvironment(Run<?,?> build, EnvVars env) Exposes the name/value as an environment variable.
String	getShortDescription() Computes a human-readable possible-localized one-line description of the parameter value.
Job	getValue() Returns the most natural Java object that represents the actual value, like boolean, string, etc.

Methods inherited from class hudson.model.ParameterValue

buildEnvVars, buildEnvVars, createBuildWrapper, createVariableResolver, equals, getAssignedLabel, getDefinition, getDescription, getFormattedDescription, getName, hashCode, isSensitive, setDescription

Methods inherited from class java.lang.Object

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

Field Detail

job

public final Job job

Constructor Detail

JobParameterValue

@DataBoundConstructor
public JobParameterValue(String name,
                                               Job job)

Method Detail

getValue

public Job getValue()

Description copied from class: ParameterValue

Returns the most natural Java object that represents the actual value, like boolean, string, etc.

Overrides:

getValue in class ParameterValue

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

public void buildEnvironment(Run<?,?> build,
                             EnvVars env)

Exposes the name/value as an environment variable.

Overrides:

buildEnvironment in class ParameterValue

Parameters:

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

env - never null.

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 returned.)

Overrides:

getShortDescription in class ParameterValue