de.westemeyer.plugins.multiselect

Class MultiselectParameterDefinition

java.lang.Object

hudson.model.ParameterDefinition

de.westemeyer.plugins.multiselect.MultiselectParameterDefinition

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.ParameterDefinition>, Serializable

public class MultiselectParameterDefinition
extends hudson.model.ParameterDefinition

The Parameter definition object is responsible for all communication between Jenkins and plugin code.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultiselectParameterDefinition.DescriptorImpl

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

hudson.model.ParameterDefinition.ParameterDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.ParameterDefinition

LIST

Constructor Summary

Constructors

Constructor and Description
MultiselectParameterDefinition(String name, String description, MultiselectDecisionTree decisionTree, MultiselectConfigurationFormat format) Create new parameter definition object.

Method Summary

Modifier and Type	Method and Description
static Queue<Integer>	createCoordinates(Integer... coordinates) Create coordinates queue from integer array.
MultiselectParameterValue	createValue(Map<String,Object> jsonObject) Extracted method reduced to use of Map instead of JSONObject for unit tests.
hudson.model.ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest staplerRequest)
hudson.model.ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest staplerRequest, net.sf.json.JSONObject jsonObject)
MultiselectDecisionTree	getDecisionTree() Get decision tree object containing all possible variable combinations.
hudson.model.ParameterValue	getDefaultParameterValue()
MultiselectConfigurationFormat	getFormat() Get content/parser format.
String[]	getItemList(Integer[] coordinates) Get item list for AJAX call from config.jelly.
String	getUuid() Get UUID to be used to distinguish JavaScript values for multiple parameters from each other.
void	setDecisionTree(MultiselectDecisionTree decisionTree) Set decision tree object containing all possible variable combinations.
void	setFormat(MultiselectConfigurationFormat format) Set content/parser format.

Methods inherited from class hudson.model.ParameterDefinition

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiselectParameterDefinition

@DataBoundConstructor
public MultiselectParameterDefinition(String name,
                                                            String description,
                                                            MultiselectDecisionTree decisionTree,
                                                            MultiselectConfigurationFormat format)

Create new parameter definition object.

Parameters:

name - parameter name

description - parameter description

decisionTree - parsed parameter definition

format - format, currently only CSV

Method Detail

getItemList

@JavaScriptMethod
public String[] getItemList(Integer[] coordinates)

Get item list for AJAX call from config.jelly.

Parameters:

coordinates - coordinates in tree, i.e. item indices from columns

Returns:

list of parameter values for given coordinates

createCoordinates

public static Queue<Integer> createCoordinates(Integer... coordinates)

Create coordinates queue from integer array.

Parameters:

coordinates - integer array

Returns:

queue for use in visitor method

getDefaultParameterValue

@Nullable
public hudson.model.ParameterValue getDefaultParameterValue()

Overrides:

getDefaultParameterValue in class hudson.model.ParameterDefinition

createValue

public hudson.model.ParameterValue createValue(org.kohsuke.stapler.StaplerRequest staplerRequest,
                                               net.sf.json.JSONObject jsonObject)

Specified by:

createValue in class hudson.model.ParameterDefinition

createValue

public MultiselectParameterValue createValue(Map<String,Object> jsonObject)

Extracted method reduced to use of Map instead of JSONObject for unit tests.

Parameters:

jsonObject - map of parsed json contents

Returns:

parameter value

createValue

public hudson.model.ParameterValue createValue(org.kohsuke.stapler.StaplerRequest staplerRequest)

Specified by:

createValue in class hudson.model.ParameterDefinition

getDecisionTree

public MultiselectDecisionTree getDecisionTree()

Get decision tree object containing all possible variable combinations.

Returns:

decision tree object containing all possible variable combinations

setDecisionTree

public void setDecisionTree(MultiselectDecisionTree decisionTree)

Set decision tree object containing all possible variable combinations.

Parameters:

decisionTree - decision tree object containing all possible variable combinations

getFormat

public MultiselectConfigurationFormat getFormat()

Get content/parser format.

Returns:

content/parser format

setFormat

public void setFormat(MultiselectConfigurationFormat format)

Set content/parser format.

Parameters:

format - content/parser format

getUuid

public String getUuid()

Get UUID to be used to distinguish JavaScript values for multiple parameters from each other.

Returns:

UUID to be used to distinguish JavaScript values for multiple parameters from each other