@Extension @Symbol(value="parameters") public static class ParametersDefinitionProperty.DescriptorImpl extends OptionalJobProperty.OptionalJobPropertyDescriptor
Descriptor.FormException, Descriptor.PropertyType, Descriptor.Selfclazz| Constructor and Description |
|---|
DescriptorImpl() |
| Modifier and Type | Method and Description |
|---|---|
String |
getDisplayName()
Human readable name of this kind of configurable object.
|
boolean |
isApplicable(Class<? extends Job> jobType)
Returns true if this
JobProperty type is applicable to the
given job type. |
ParametersDefinitionProperty |
newInstance(org.kohsuke.stapler.StaplerRequest req,
net.sf.json.JSONObject formData)
Creates a configured instance from the submitted form.
|
all, getPropertyDescriptorsaddHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMappublic ParametersDefinitionProperty newInstance(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData) throws Descriptor.FormException
JobPropertyDescriptorHudson 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 OptionalJobProperty.OptionalJobPropertyDescriptorreq - 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.JobProperty to the target project (or just use OptionalJobProperty)Descriptor.FormException - Signals a problem in the submitted form.public boolean isApplicable(Class<? extends Job> jobType)
JobPropertyDescriptorJobProperty type is applicable to the
given job type.
The default implementation of this method checks if the given job type is assignable to J of
JobProperty<J>, but subtypes can extend this to change this behavior.
isApplicable in class JobPropertyDescriptorpublic String getDisplayName()
DescriptorClass.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 Descriptor<JobProperty<?>>Copyright © 2004–2018. All rights reserved.