Package io.jenkins.plugins.restlistparam

Class RestListParameterDefinition

java.lang.Object

hudson.model.ParameterDefinition

hudson.model.SimpleParameterDefinition

io.jenkins.plugins.restlistparam.AbstractRestListParameterDefinition

io.jenkins.plugins.restlistparam.RestListParameterDefinition

All Implemented Interfaces:

ExtensionPoint, Describable<ParameterDefinition>, Serializable

public final class RestListParameterDefinition
extends AbstractRestListParameterDefinition

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RestListParameterDefinition.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
RestListParameterDefinition(String name, String description, String restEndpoint, String credentialId, MimeType mimeType, String valueExpression, String displayExpression)
RestListParameterDefinition(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)
boolean	equals(Object obj)
int	hashCode()
boolean	isDefaultSelected(ValueItem item)	In dropdown mode, the entry displayed as the default value is preselected.
boolean	isValid(ParameterValue value)
String	resolveFreeTextDefault(List<ValueItem> values)	The value the dropdown preselects with validation disabled.

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

RestListParameterDefinition

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

RestListParameterDefinition

public RestListParameterDefinition(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

resolveFreeTextDefault

public String resolveFreeTextDefault(List<ValueItem> values)

The value the dropdown preselects with validation disabled. The default value refers to a display value, as in dropdown mode, so it resolves to the value of the first entry displayed as the default; a default that matches no entry stays verbatim and becomes a custom value.

Parameters:

values - The entries already fetched for this form

Returns:

The matching entry's value, otherwise the default value verbatim

isDefaultSelected

public boolean isDefaultSelected(ValueItem item)

In dropdown mode, the entry displayed as the default value is preselected.

Specified by:

isDefaultSelected in class AbstractRestListParameterDefinition

Parameters:

item - A fetched entry

Returns:

Whether the build form preselects the entry because of the default value

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)

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