org.biouno.unochoice

Class DynamicReferenceParameter

java.lang.Object

hudson.model.ParameterDefinition

hudson.model.SimpleParameterDefinition

org.biouno.unochoice.AbstractUnoChoiceParameter

org.biouno.unochoice.AbstractScriptableParameter

org.biouno.unochoice.AbstractCascadableParameter

org.biouno.unochoice.DynamicReferenceParameter

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.ParameterDefinition>, Serializable, CascadableParameter<Map<Object,Object>>, ScriptableParameter<Map<Object,Object>>, UnoChoiceParameter

public class DynamicReferenceParameter
extends AbstractCascadableParameter

Provides a dynamic reference parameter for users. This is a not so elegant solution, since we are using a ParameterDefinition extension point, but it actually doesn't provide any parameter value.

This kind of parameter is only for reference. An use case is when you have several job parameters, but your input values may vary depending on previous executions. You can get the previous executions by accessing from your Groovy code the jenkinsProject variable.

Its options are retrieved from the evaluation of a Groovy script.

Since:

0.1

Author:

Bruno P. Kinoshita

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DynamicReferenceParameter.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 org.biouno.unochoice.AbstractCascadableParameter

parameters

Fields inherited from class org.biouno.unochoice.AbstractScriptableParameter

script, SEPARATOR

Fields inherited from class org.biouno.unochoice.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 hudson.model.ParameterDefinition

LIST

Constructor Summary

Constructors

Constructor and Description
DynamicReferenceParameter(String name, String description, Script script, String choiceType, String referencedParameters, Boolean omitValueField) Deprecated. see JENKINS-32149
DynamicReferenceParameter(String name, String description, String randomName, Script script, String choiceType, String referencedParameters, Boolean omitValueField) Constructor called from Jelly with parameters.

Method Summary

Methods

Modifier and Type	Method and Description
String	getChoicesAsStringForUI()
String	getChoiceType() Gets the choice type.
Boolean	getOmitValueField()
Map<Object,Object>	getParameters() Gets the current parameters, be it before or after other referenced parameters triggered an update.

Methods inherited from class org.biouno.unochoice.AbstractCascadableParameter

doUpdate, getChoicesForUI, getReferencedParameters, getReferencedParametersAsArray

Methods inherited from class org.biouno.unochoice.AbstractScriptableParameter

getChoices, getChoices, getChoicesAsString, getChoicesAsString, getDefaultParameterValue, getScript, getVisibleItemCount

Methods inherited from class org.biouno.unochoice.AbstractUnoChoiceParameter

all, createValue, createValue, getDescriptor, getRandomName

Methods inherited from class hudson.model.SimpleParameterDefinition

createValue, createValue

Methods inherited from class hudson.model.ParameterDefinition

copyWithDefaultValue, getDescription, getFormattedDescription, getName, getType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.biouno.unochoice.ScriptableParameter

getChoices

Constructor Detail

DynamicReferenceParameter

public DynamicReferenceParameter(String name,
                         String description,
                         Script script,
                         String choiceType,
                         String referencedParameters,
                         Boolean omitValueField)

Deprecated. see JENKINS-32149

Constructor called from Jelly with parameters.

Parameters:

name - name

description - description

script - script

choiceType - choice type

referencedParameters - referenced parameters

omitValueField - used in the UI to decide whether to include a hidden empty <input name=value>. false by default.

DynamicReferenceParameter

@DataBoundConstructor
public DynamicReferenceParameter(String name,
                                              String description,
                                              String randomName,
                                              Script script,
                                              String choiceType,
                                              String referencedParameters,
                                              Boolean omitValueField)

Constructor called from Jelly with parameters.

Parameters:

name - name

description - description

randomName - parameter random generated name (uuid)

script - script

choiceType - choice type

referencedParameters - referenced parameters

omitValueField - used in the UI to decide whether to include a hidden empty <input name=value>. false by default.

Method Detail

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

getOmitValueField

public Boolean getOmitValueField()

getParameters

public Map<Object,Object> getParameters()

Gets the current parameters, be it before or after other referenced parameters triggered an update. Populates parameters common to all evaluations, such as jenkinsProject, which is the current Jenkins project. This parameter also includes the Jenkins project and build objects in the Groovy variables map. It means that you can use these two in your code for rendering the parameter.

Overrides:

getParameters in class AbstractCascadableParameter

Returns:

the current parameters with pre-populated defaults

getChoicesAsStringForUI

@JavaScriptMethod
public String getChoicesAsStringForUI()