Package org.biouno.unochoice

Class AbstractUnoChoiceParameter

java.lang.Object

hudson.model.ParameterDefinition

hudson.model.SimpleParameterDefinition

org.biouno.unochoice.AbstractUnoChoiceParameter

All Implemented Interfaces:

ExtensionPoint, Describable<ParameterDefinition>, Serializable, UnoChoiceParameter

Direct Known Subclasses:

AbstractScriptableParameter

public abstract class AbstractUnoChoiceParameter
extends SimpleParameterDefinition
implements UnoChoiceParameter

Abstract Uno Choice parameter. Provides basic methods common to all Uno Choice parameters.

Since:

0.20

Author:

Bruno P. Kinoshita

See Also:

• Serialized Form

Nested Class Summary

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

ParameterDefinition.ParameterDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MAX_VISIBLE_ITEM_COUNT
static final String	ELEMENT_TYPE_FORMATTED_HIDDEN_HTML
static final String	ELEMENT_TYPE_FORMATTED_HTML
static final String	ELEMENT_TYPE_ORDERED_LIST
static final String	ELEMENT_TYPE_TEXT_BOX
static final String	ELEMENT_TYPE_UNORDERED_LIST
protected static final Logger	LOGGER
static final String	PARAMETER_TYPE_CHECK_BOX
static final String	PARAMETER_TYPE_MULTI_SELECT
static final String	PARAMETER_TYPE_RADIO
static final String	PARAMETER_TYPE_SINGLE_SELECT

Fields inherited from class hudson.model.ParameterDefinition

LIST

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractUnoChoiceParameter(String name, String description)	Deprecated. to fix JENKINS-32149 (create random name only once - this is the parameter ID)
protected	AbstractUnoChoiceParameter(String name, String description, String randomName)	Inherited constructor.

Method Summary

Modifier and Type	Method	Description
ParameterValue	createValue(String value)
ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest2 request, net.sf.json.JSONObject json)
abstract String	getChoiceType()	Gets the choice type.
ParameterDefinition.ParameterDescriptor	getDescriptor()
String	getRandomName()	Gets the randomly generated parameter name.

Methods inherited from class hudson.model.SimpleParameterDefinition

createValue, createValue

Methods inherited from class hudson.model.ParameterDefinition

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

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

protected static final Logger LOGGER

PARAMETER_TYPE_SINGLE_SELECT

public static final String PARAMETER_TYPE_SINGLE_SELECT

See Also:

• Constant Field Values

PARAMETER_TYPE_MULTI_SELECT

public static final String PARAMETER_TYPE_MULTI_SELECT

See Also:

• Constant Field Values

PARAMETER_TYPE_CHECK_BOX

public static final String PARAMETER_TYPE_CHECK_BOX

See Also:

• Constant Field Values

PARAMETER_TYPE_RADIO

public static final String PARAMETER_TYPE_RADIO

See Also:

• Constant Field Values

ELEMENT_TYPE_TEXT_BOX

public static final String ELEMENT_TYPE_TEXT_BOX

See Also:

• Constant Field Values

ELEMENT_TYPE_ORDERED_LIST

public static final String ELEMENT_TYPE_ORDERED_LIST

See Also:

• Constant Field Values

ELEMENT_TYPE_UNORDERED_LIST

public static final String ELEMENT_TYPE_UNORDERED_LIST

See Also:

• Constant Field Values

ELEMENT_TYPE_FORMATTED_HTML

public static final String ELEMENT_TYPE_FORMATTED_HTML

See Also:

• Constant Field Values

ELEMENT_TYPE_FORMATTED_HIDDEN_HTML

public static final String ELEMENT_TYPE_FORMATTED_HIDDEN_HTML

See Also:

• Constant Field Values

DEFAULT_MAX_VISIBLE_ITEM_COUNT

public static final int DEFAULT_MAX_VISIBLE_ITEM_COUNT

See Also:

• Constant Field Values

Constructor Details

AbstractUnoChoiceParameter

@Deprecated
protected AbstractUnoChoiceParameter(String name,
 String description)

Deprecated.

to fix JENKINS-32149 (create random name only once - this is the parameter ID)

Inherited constructor. .

Parameters:

name - name

description - description FIXME: remove in new major release

AbstractUnoChoiceParameter

protected AbstractUnoChoiceParameter(String name,
 String description,
 String randomName)

Inherited constructor. .

Parameters:

name - name

description - description

randomName - the parameter unique ID (a random uuid) created once per parameter. If blank or null it will be created a new random parameter name that starts with choice-parameter

Method Details

getRandomName

public String getRandomName()

Gets the randomly generated parameter name. Used in the UI for objecting binding.

Returns:

a random string, created during object instantiation.

createValue

public ParameterValue createValue(String value)

Specified by:

createValue in class SimpleParameterDefinition

createValue

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

Overrides:

createValue in class ParameterDefinition

getChoiceType

public abstract String getChoiceType()

Gets the choice type.

This method can be called from Javascript

Returns:

choice type

getDescriptor

public ParameterDefinition.ParameterDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<ParameterDefinition>

Overrides:

getDescriptor in class ParameterDefinition