@Extension @Symbol(value={"choice","choiceParam"}) public static class ChoiceParameterDefinition.DescriptorImpl extends ParameterDefinition.ParameterDescriptor
Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self
clazz
Constructor and Description |
---|
DescriptorImpl() |
Modifier and Type | Method and Description |
---|---|
FormValidation |
doCheckChoices(String value)
Checks if parameterized build choices are valid.
|
String |
getDisplayName()
Human readable name of this kind of configurable object.
|
String |
getHelpFile()
Returns the resource path to the help screen HTML, if any.
|
ParameterDefinition |
newInstance(org.kohsuke.stapler.StaplerRequest req,
net.sf.json.JSONObject formData)
Creates a configured instance from the submitted form.
|
getValuePage
addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap
public String getDisplayName()
Descriptor
Class.getSimpleName()
on Descriptor.clazz
, so for example MyThing
from some.pkg.MyThing.DescriptorImpl
.
Historically some implementations returned null as a way of hiding the descriptor from the UI,
but this is generally managed by an explicit method such as isEnabled
or isApplicable
.getDisplayName
in class ParameterDefinition.ParameterDescriptor
public String getHelpFile()
Descriptor
Starting 1.282, this method uses "convention over configuration" — you should just put the "help.html" (and its localized versions, if any) in the same directory you put your Jelly view files, and this method will automatically does the right thing.
This value is relative to the context root of Hudson, so normally
the values are something like "/plugin/emma/help.html"
to
refer to static resource files in a plugin, or "/publisher/EmmaPublisher/abc"
to refer to Jelly script abc.jelly
or a method EmmaPublisher.doAbc()
.
getHelpFile
in class Descriptor<ParameterDefinition>
public ParameterDefinition newInstance(@Nullable org.kohsuke.stapler.StaplerRequest req, @NonNull net.sf.json.JSONObject formData) throws Descriptor.FormException
Descriptor
Hudson only invokes this method when the user wants an instance of T
.
So there's no need to check that in the implementation.
Starting 1.206, the default implementation of this method does the following:
req.bindJSON(clazz,formData);
... which performs the databinding on the constructor of Descriptor.clazz
.
For some types of Describable
, such as ListViewColumn
, this method
can be invoked with null request object for historical reason. Such design is considered
broken, but due to the compatibility reasons we cannot fix it. Because of this, the
default implementation gracefully handles null request, but the contract of the method
still is "request is always non-null." Extension points that need to define the "default instance"
semantics should define a descriptor subtype and add the no-arg newInstance method.
newInstance
in class Descriptor<ParameterDefinition>
req
- Always non-null (see note above.) This object includes represents the entire submission.formData
- The JSON object that captures the configuration data for this Descriptor
.
See http://wiki.jenkins-ci.org/display/JENKINS/Structured+Form+Submission
Always non-null.Descriptor.FormException
- Signals a problem in the submitted form.public FormValidation doCheckChoices(@QueryParameter String value)
Copyright © 2004–2021. All rights reserved.