Package hudson.model

Class ParametersDefinitionProperty.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<JobProperty<?>>

hudson.model.JobPropertyDescriptor

jenkins.model.OptionalJobProperty.OptionalJobPropertyDescriptor

hudson.model.ParametersDefinitionProperty.DescriptorImpl

All Implemented Interfaces:

Saveable, OnMaster

Enclosing class:

ParametersDefinitionProperty

@Extension
@Symbol("parameters")
public static class ParametersDefinitionProperty.DescriptorImpl
extends OptionalJobProperty.OptionalJobPropertyDescriptor

Nested Class Summary

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

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
DescriptorImpl()

Method Summary

Modifier and Type	Method	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.

Methods inherited from class hudson.model.JobPropertyDescriptor

all, getPropertyDescriptors

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, 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, getRequiredGlobalConfigPagePermission, 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

DescriptorImpl

public DescriptorImpl()

Method Detail

newInstance

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

Description copied from class: Descriptor

Creates a configured instance from the submitted form.

Hudson only invokes this method when the user wants an instance of T. So there's no need to check that in the implementation.

The default implementation of this method uses Descriptor.bindJSON(org.kohsuke.stapler.StaplerRequest, java.lang.Class<T>, net.sf.json.JSONObject) 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.

Overrides:

newInstance in class OptionalJobProperty.OptionalJobPropertyDescriptor

Parameters:

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 the developer documentation. Always non-null.

Returns:

null to avoid setting an instance of JobProperty to the target project (or just use OptionalJobProperty)

Throws:

Descriptor.FormException - Signals a problem in the submitted form.

isApplicable

public boolean isApplicable(Class<? extends Job> jobType)

Description copied from class: JobPropertyDescriptor

Returns true if this JobProperty 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.

Overrides:

isApplicable in class JobPropertyDescriptor

Returns:

true to indicate applicable, in which case the property will be displayed in the configuration screen of this job.

getDisplayName

@NonNull
public String getDisplayName()

Description copied from class: Descriptor

Human readable name of this kind of configurable object. Should be overridden for most descriptors, if the display name is visible somehow. As a fallback it uses 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.

Overrides:

getDisplayName in class Descriptor<JobProperty<?>>