Package io.jenkins.plugins.restlistparam

Class RestMultiListParameterDefinition

java.lang.Object

hudson.model.ParameterDefinition

hudson.model.SimpleParameterDefinition

io.jenkins.plugins.restlistparam.AbstractRestListParameterDefinition

io.jenkins.plugins.restlistparam.RestMultiListParameterDefinition

All Implemented Interfaces:

ExtensionPoint, Describable<ParameterDefinition>, Serializable

public final class RestMultiListParameterDefinition
extends AbstractRestListParameterDefinition

A parameter whose value is an ordered list of entries chosen from a REST endpoint's response.

It stays a SimpleParameterDefinition, so string input from the CLI, the remote API and the Pipeline build step is read by createValue(String) with MultiValueCodec.parse(String). The remote API therefore takes the list as one Json array; core rejects a repeated query parameter name.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RestMultiListParameterDefinition.DescriptorImpl

Nested classes/interfaces inherited from class hudson.model.ParameterDefinition

ParameterDefinition.ParameterDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class io.jenkins.plugins.restlistparam.AbstractRestListParameterDefinition

config

Fields inherited from class hudson.model.ParameterDefinition

LIST

Constructor Summary

Constructors

Constructor	Description
RestMultiListParameterDefinition(String name, String description, String restEndpoint, String credentialId, MimeType mimeType, String valueExpression, String displayExpression)
RestMultiListParameterDefinition(String name, String description, String restEndpoint, String credentialId, MimeType mimeType, String valueExpression, String displayExpression, ValueOrder valueOrder, String filter, Integer cacheTime, String defaultValue, boolean allowEmptyValue)

Method Summary

Modifier and Type	Method	Description
ParameterDefinition	copyWithDefaultValue(ParameterValue defaultValue)
ParameterValue	createValue(String value)
ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject jo)	Reads the build form, which submits a <select multiple> as a Json array of the selected options' values.
boolean	equals(Object obj)
List<String>	getUnmatchedDefaults(List<ValueItem> values)	The default values that match no fetched entry's display value.
int	hashCode()
boolean	isDefaultSelected(ValueItem item)
boolean	isValid(ParameterValue value)

Methods inherited from class io.jenkins.plugins.restlistparam.AbstractRestListParameterDefinition

createLoader, createLoader, entryValuesFor, getCacheTime, getCredentialId, getCustomHeaders, getCustomValueLabel, getDefaultValue, getDisplayExpression, getErrorMsg, getFilter, getMimeType, getPagination, getRestEndpoint, getValueExpression, getValueOrder, getValues, isAllowEmptyValue, isEnableValidation, setAllowEmptyValue, setCacheTime, setCustomHeaders, setDefaultValue, setDisplayExpression, setEnableValidation, setFilter, setPagination, setValueOrder

Methods inherited from class hudson.model.SimpleParameterDefinition

createValue, createValue

Methods inherited from class hudson.model.ParameterDefinition

all, createValue, createValue, getDefaultParameterValue, getDescription, getDescriptor, getFormattedDescription, getName, getType, setDescription

Methods inherited from class java.lang.Object

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

Constructor Details

RestMultiListParameterDefinition

@DataBoundConstructor
public RestMultiListParameterDefinition(String name,
 String description,
 String restEndpoint,
 String credentialId,
 MimeType mimeType,
 String valueExpression,
 String displayExpression)

RestMultiListParameterDefinition

public RestMultiListParameterDefinition(String name,
 String description,
 String restEndpoint,
 String credentialId,
 MimeType mimeType,
 String valueExpression,
 String displayExpression,
 ValueOrder valueOrder,
 String filter,
 Integer cacheTime,
 String defaultValue,
 boolean allowEmptyValue)

Method Details

isDefaultSelected

public boolean isDefaultSelected(ValueItem item)

Specified by:

isDefaultSelected in class AbstractRestListParameterDefinition

Parameters:

item - A fetched entry

Returns:

Whether the entry's display value is one of the default values

getUnmatchedDefaults

public List<String> getUnmatchedDefaults(List<ValueItem> values)

The default values that match no fetched entry's display value. They are offered as preselected free-form entries when validation is disabled, and ignored when it is enabled.

Parameters:

values - The entries already fetched for this form

Returns:

The unmatched, non-empty default values in order, or an empty list when validation is enabled

copyWithDefaultValue

public ParameterDefinition copyWithDefaultValue(ParameterValue defaultValue)

Overrides:

copyWithDefaultValue in class ParameterDefinition

createValue

public ParameterValue createValue(String value)

Specified by:

createValue in class SimpleParameterDefinition

createValue

public ParameterValue createValue(org.kohsuke.stapler.StaplerRequest2 req,
 net.sf.json.JSONObject jo)

Reads the build form, which submits a <select multiple> as a Json array of the selected options' values. A string is read with the string input rule; an absent value is the empty list.

Overrides:

createValue in class ParameterDefinition

isValid

public boolean isValid(ParameterValue value)

Overrides:

isValid in class ParameterDefinition

hashCode

public int hashCode()

Overrides:

hashCode in class ParameterDefinition

equals

public boolean equals(Object obj)

Overrides:

equals in class ParameterDefinition