Class ChoiceParameter

java.lang.Object

hudson.model.ParameterDefinition

hudson.model.SimpleParameterDefinition

org.biouno.unochoice.AbstractUnoChoiceParameter

org.biouno.unochoice.AbstractScriptableParameter

org.biouno.unochoice.ChoiceParameter

All Implemented Interfaces:

ExtensionPoint, Describable<ParameterDefinition>, Serializable, ScriptableParameter<Map<Object,Object>>, UnoChoiceParameter

public class ChoiceParameter
extends AbstractScriptableParameter

A parameter that renders its options as a choice (select) HTML component.

Since:

0.1

Author:

Bruno P. Kinoshita

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ChoiceParameter.DescriptImpl

Nested classes/interfaces inherited from class ParameterDefinition

ParameterDefinition.ParameterDescriptor

Nested classes/interfaces inherited from interface ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class AbstractScriptableParameter

EQUALS, JENKINS_BUILD_VARIABLE_NAME, JENKINS_PARAMETER_VARIABLE_NAME, JENKINS_PROJECT_VARIABLE_NAME, script, SEPARATOR

Fields inherited from class AbstractUnoChoiceParameter

DEFAULT_MAX_VISIBLE_ITEM_COUNT, ELEMENT_TYPE_FORMATTED_HIDDEN_HTML, ELEMENT_TYPE_FORMATTED_HTML, ELEMENT_TYPE_ORDERED_LIST, ELEMENT_TYPE_TEXT_BOX, ELEMENT_TYPE_UNORDERED_LIST, LOGGER, PARAMETER_TYPE_CHECK_BOX, PARAMETER_TYPE_MULTI_SELECT, PARAMETER_TYPE_RADIO, PARAMETER_TYPE_SINGLE_SELECT

Fields inherited from class ParameterDefinition

LIST

Constructor Summary

Constructors

Constructor	Description
ChoiceParameter(String name, String description, String randomName, Script script, String choiceType, Boolean filterable)	Deprecated. see JENKINS-31625
ChoiceParameter(String name, String description, String randomName, Script script, String choiceType, Boolean filterable, Integer filterLength)	Constructor called from Jelly with parameters.
ChoiceParameter(String name, String description, Script script, String choiceType, Boolean filterable)	Deprecated. see JENKINS-32149

Method Summary

Modifier and Type	Method	Description
String	getChoiceType()	Gets the choice type.
ParameterValue	getDefaultParameterValue()	Returns the default value for this parameter.
boolean	getFilterable()	Get the filter flag.
Integer	getFilterLength()	Get the filter length.

Methods inherited from class AbstractScriptableParameter

detectProject, getCacheDefaultValue, getChoices, getChoices, getChoicesAsString, getChoicesAsString, getItemCount, getParameters, getScript, getVisibleItemCount, setCacheDefaultValue

Methods inherited from class AbstractUnoChoiceParameter

createValue, createValue, getDescriptor, getRandomName

Methods inherited from class SimpleParameterDefinition

createValue, createValue

Methods inherited from class ParameterDefinition

all, copyWithDefaultValue, createValue, createValue, equals, getDescription, getFormattedDescription, getName, getType, hashCode, isValid, setDescription

Methods inherited from class Object

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

Constructor Details

ChoiceParameter

@Deprecated
public ChoiceParameter(String name,
 String description,
 Script script,
 String choiceType,
 Boolean filterable)

Deprecated.

see JENKINS-32149

Constructor called from Jelly with parameters.

Parameters:

name - name

description - description

script - script

choiceType - choice type

filterable - filter flag

ChoiceParameter

@Deprecated
public ChoiceParameter(String name,
 String description,
 String randomName,
 Script script,
 String choiceType,
 Boolean filterable)

Deprecated.

see JENKINS-31625

Constructor called from Jelly with parameters.

Parameters:

name - name

description - description

randomName - parameter random generated name

script - script

choiceType - choice type

filterable - filter flag

ChoiceParameter

@DataBoundConstructor
public ChoiceParameter(String name,
 String description,
 String randomName,
 Script script,
 String choiceType,
 Boolean filterable,
 Integer filterLength)

Constructor called from Jelly with parameters.

Parameters:

name - name

description - description

randomName - parameter random generated name

script - script

choiceType - choice type

filterable - filter flag

filterLength - length when filter start filtering

Method Details

getChoiceType

public String getChoiceType()

Description copied from class: AbstractUnoChoiceParameter

Gets the choice type.

This method can be called from Javascript

Specified by:

getChoiceType in class AbstractUnoChoiceParameter

Returns:

choice type

getFilterable

public boolean getFilterable()

Get the filter flag.

Returns:

filter flag

getFilterLength

public Integer getFilterLength()

Get the filter length.

Returns:

filter length

getDefaultParameterValue

public ParameterValue getDefaultParameterValue()

Returns the default value for this parameter.

For checkbox parameters (JENKINS-75760), the default value is derived from the choices marked as selected in the choice metadata. If no choices are selected, an empty value is returned.

Overrides:

getDefaultParameterValue in class AbstractScriptableParameter

Returns:

the default parameter value, or a comma-separated list of selected checkbox values