Package io.jenkins.plugins.restlistparam

Class RestMultiListParameterValue

java.lang.Object

hudson.model.ParameterValue

io.jenkins.plugins.restlistparam.RestMultiListParameterValue

All Implemented Interfaces:

Serializable

public final class RestMultiListParameterValue
extends ParameterValue

ParameterValue created from RestMultiListParameterDefinition: an ordered list of distinct strings. Pipeline receives the list itself; the build environment receives it as a compact Json array (see MultiValueCodec.encode(List)).

See Also:

• Serialized Form

Field Summary

Fields inherited from class hudson.model.ParameterValue

name

Constructor Summary

Constructors

Constructor	Description
RestMultiListParameterValue(String name, List<String> value)
RestMultiListParameterValue(String name, List<String> value, String description)

Method Summary

Modifier and Type	Method	Description
void	buildEnvironment(Run<?,?> build, EnvVars env)	Exposes the name/value as an environment variable holding the Json array.
VariableResolver<String>	createVariableResolver(AbstractBuild<?,?> build)
boolean	equals(Object obj)
String	getShortDescription()
List<String>	getValue()
int	hashCode()
String	toString()

Methods inherited from class hudson.model.ParameterValue

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

Methods inherited from class java.lang.Object

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

Constructor Details

RestMultiListParameterValue

@DataBoundConstructor
public RestMultiListParameterValue(String name,
 List<String> value)

RestMultiListParameterValue

public RestMultiListParameterValue(String name,
 List<String> value,
 String description)

Parameters:

value - The elements in the order supplied; duplicates are collapsed, keeping the first occurrence. null means the value is missing.

Method Details

buildEnvironment

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

Exposes the name/value as an environment variable holding the Json array.

Overrides:

buildEnvironment in class ParameterValue

createVariableResolver

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

Overrides:

createVariableResolver in class ParameterValue

getValue

@Exported(visibility=4)
public List<String> getValue()

Overrides:

getValue in class ParameterValue

Returns:

The unmodifiable list of elements, or null when the value is missing

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()

Overrides:

getShortDescription in class ParameterValue