jp.ikedam.jenkins.plugins.extensible_choice_parameter

Class ExtensibleChoiceParameterDefinition.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<hudson.model.ParameterDefinition>

hudson.model.ParameterDefinition.ParameterDescriptor

jp.ikedam.jenkins.plugins.extensible_choice_parameter.ExtensibleChoiceParameterDefinition.DescriptorImpl

All Implemented Interfaces:

hudson.model.Saveable

Enclosing class:

ExtensibleChoiceParameterDefinition

@Extension
public static class ExtensibleChoiceParameterDefinition.DescriptorImpl
extends hudson.model.ParameterDefinition.ParameterDescriptor

The internal class to work with views. The following files are used (put in main/resource directory in the source tree).

config.jelly

shown as a part of a job configuration page.

index.jelly

shown when a user launches a build, and specifies parameters of the build.

Nested Class Summary

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

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
ExtensibleChoiceParameterDefinition.DescriptorImpl()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
hudson.util.FormValidation	doCheckName(String name)
protected Map<String,Boolean>	getChoiceListEnabledMap()
hudson.DescriptorExtensionList<ChoiceListProvider,hudson.model.Descriptor<ChoiceListProvider>>	getChoiceListProviderList() Returns all the available methods to provide choices.
String	getDisplayName() Returns the string to be shown in a job configuration page, in the dropdown of "Add Parameter".
List<hudson.model.Descriptor<ChoiceListProvider>>	getEnabledChoiceListProviderList() Returns all the available methods to provide choices that are enabled in the global configuration.
boolean	isProviderEnabled(hudson.model.Descriptor<?> d)
ExtensibleChoiceParameterDefinition	newInstance(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData) Create a new instance of SystemGroovyChoiceListProvider from user inputs.
protected void	setChoiceListEnabledMap(Map<String,Boolean> choiceListEnabledMap)

Methods inherited from class hudson.model.ParameterDefinition.ParameterDescriptor

getValuePage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, getCheckUrl, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtensibleChoiceParameterDefinition.DescriptorImpl

public ExtensibleChoiceParameterDefinition.DescriptorImpl()

Method Detail

setChoiceListEnabledMap

protected void setChoiceListEnabledMap(Map<String,Boolean> choiceListEnabledMap)

getChoiceListEnabledMap

protected Map<String,Boolean> getChoiceListEnabledMap()

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                net.sf.json.JSONObject json)
                  throws hudson.model.Descriptor.FormException

Overrides:

configure in class hudson.model.Descriptor<hudson.model.ParameterDefinition>

Throws:

hudson.model.Descriptor.FormException

isProviderEnabled

public boolean isProviderEnabled(hudson.model.Descriptor<?> d)

newInstance

public ExtensibleChoiceParameterDefinition newInstance(org.kohsuke.stapler.StaplerRequest req,
                                              net.sf.json.JSONObject formData)
                                                throws hudson.model.Descriptor.FormException

Create a new instance of SystemGroovyChoiceListProvider from user inputs.

Overrides:

newInstance in class hudson.model.Descriptor<hudson.model.ParameterDefinition>

Parameters:

req -

formData -

Returns:

Throws:

hudson.model.Descriptor.FormException

See Also:

Descriptor.newInstance(org.kohsuke.stapler.StaplerRequest, net.sf.json.JSONObject)

getDisplayName

public String getDisplayName()

Returns the string to be shown in a job configuration page, in the dropdown of "Add Parameter".

Overrides:

getDisplayName in class hudson.model.ParameterDefinition.ParameterDescriptor

Returns:

a name of this parameter type.

See Also:

ParameterDefinition.ParameterDescriptor.getDisplayName()

getChoiceListProviderList

public hudson.DescriptorExtensionList<ChoiceListProvider,hudson.model.Descriptor<ChoiceListProvider>> getChoiceListProviderList()

Returns all the available methods to provide choices.

Returns:

DescriptorExtensionList of ChoiceListProvider subclasses.

getEnabledChoiceListProviderList

public List<hudson.model.Descriptor<ChoiceListProvider>> getEnabledChoiceListProviderList()

Returns all the available methods to provide choices that are enabled in the global configuration. Used for showing dropdown for users to select a choice provider.

Returns:

DescriptorExtensionList of ChoiceListProvider subclasses.

doCheckName

public hudson.util.FormValidation doCheckName(@QueryParameter
                                     String name)