Package io.jenkins.plugins.smartselect

Class SmartSelectParameterDefinition

java.lang.Object

hudson.model.ParameterDefinition

io.jenkins.plugins.smartselect.SmartSelectParameterDefinition

All Implemented Interfaces:

ExtensionPoint, Describable<ParameterDefinition>, Serializable

public class SmartSelectParameterDefinition
extends ParameterDefinition

A build parameter that selects zero or more known choices in a searchable dropdown.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SmartSelectParameterDefinition.DescriptorImpl
static final class	SmartSelectParameterDefinition.OptionView

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 hudson.model.ParameterDefinition

LIST

Constructor Summary

Constructors

Constructor	Description
SmartSelectParameterDefinition(String name)

Method Summary

Modifier and Type	Method	Description
ParameterDefinition	copyWithDefaultValue(ParameterValue value)
StringParameterValue	createValue(CLICommand command, String value)
StringParameterValue	createValue(String submitted)
StringParameterValue	createValue(org.kohsuke.stapler.StaplerRequest2 request)
ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject formData)	HTML form submission: the UI stores comma-delimited results in a hidden value field.
boolean	equals(Object obj)
int	getCacheSeconds()
List<String>	getChoices()
String	getChoicesText()
StringParameterValue	getDefaultParameterValue()
String	getDefaultValueForBuild()
List<String>	getDefaultValues()
String	getDefaultValuesText()
List<String>	getDependencies()
String	getDependsOn()
String	getMode()
List<SelectOption>	getOptions()
List<SelectOption>	getOptionsFor(Job<?,?> job, Map<String,String> submitted)
String	getOptionsText()
List<SelectOption>	getResolvedOptions()
String	getRestItemsPath()
Secret	getRestToken()
String	getRestUrl()
SmartSelectParameterDefinition.OptionView	getView()
int	hashCode()
boolean	isInitiallySelected(String choice)
boolean	isMulti()
boolean	isRemote()
boolean	isSearchable()
boolean	isValid(ParameterValue value)
void	setCacheSeconds(int value)
void	setChoices(Object choices)	A list works in Jenkinsfile; textarea string works in the job config UI.
void	setDefaultValues(Object defaults)
void	setDependsOn(String value)
void	setMode(String mode)
void	setOptions(Object input)
void	setRestItemsPath(String value)
void	setRestToken(String value)
void	setRestUrl(String value)
void	setSearchable(boolean searchable)

Methods inherited from class hudson.model.ParameterDefinition

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

Methods inherited from class java.lang.Object

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

Constructor Details

SmartSelectParameterDefinition

@DataBoundConstructor
public SmartSelectParameterDefinition(String name)

Method Details

getDependsOn

public String getDependsOn()

setDependsOn

@DataBoundSetter
public void setDependsOn(String value)

getDependencies

public List<String> getDependencies()

getOptionsFor

public List<SelectOption> getOptionsFor(Job<?,?> job,
 Map<String,String> submitted)

getRestUrl

public String getRestUrl()

setRestUrl

@DataBoundSetter
public void setRestUrl(String value)

getRestItemsPath

public String getRestItemsPath()

setRestItemsPath

@DataBoundSetter
public void setRestItemsPath(String value)

getRestToken

public Secret getRestToken()

setRestToken

@DataBoundSetter
public void setRestToken(String value)

getCacheSeconds

public int getCacheSeconds()

setCacheSeconds

@DataBoundSetter
public void setCacheSeconds(int value)

isRemote

public boolean isRemote()

getView

public SmartSelectParameterDefinition.OptionView getView()

getOptions

public List<SelectOption> getOptions()

setOptions

@DataBoundSetter
public void setOptions(Object input)

getOptionsText

public String getOptionsText()

getResolvedOptions

public List<SelectOption> getResolvedOptions()

getChoices

public List<String> getChoices()

setChoices

@DataBoundSetter
public void setChoices(Object choices)

A list works in Jenkinsfile; textarea string works in the job config UI.

getChoicesText

public String getChoicesText()

getDefaultValues

public List<String> getDefaultValues()

setDefaultValues

@DataBoundSetter
public void setDefaultValues(Object defaults)

getDefaultValuesText

public String getDefaultValuesText()

getMode

public String getMode()

setMode

@DataBoundSetter
public void setMode(String mode)

isSearchable

public boolean isSearchable()

setSearchable

@DataBoundSetter
public void setSearchable(boolean searchable)

isMulti

public boolean isMulti()

getDefaultValueForBuild

public String getDefaultValueForBuild()

isInitiallySelected

public boolean isInitiallySelected(String choice)

getDefaultParameterValue

public StringParameterValue getDefaultParameterValue()

Overrides:

getDefaultParameterValue in class ParameterDefinition

createValue

public StringParameterValue createValue(String submitted)

createValue

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

HTML form submission: the UI stores comma-delimited results in a hidden value field.

Overrides:

createValue in class ParameterDefinition

createValue

public StringParameterValue createValue(org.kohsuke.stapler.StaplerRequest2 request)

Overrides:

createValue in class ParameterDefinition

createValue

public StringParameterValue createValue(CLICommand command,
 String value)

Overrides:

createValue in class ParameterDefinition

isValid

public boolean isValid(ParameterValue value)

Overrides:

isValid in class ParameterDefinition

copyWithDefaultValue

public ParameterDefinition copyWithDefaultValue(ParameterValue value)

Overrides:

copyWithDefaultValue in class ParameterDefinition

hashCode

public int hashCode()

Overrides:

hashCode in class ParameterDefinition

equals

public boolean equals(Object obj)

Overrides:

equals in class ParameterDefinition