Package hudson.tasks

Class Maven.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<Builder>

hudson.tasks.Maven.DescriptorImpl

All Implemented Interfaces:

PersistentDescriptor, Saveable, OnMaster

Enclosing class:

Maven

@Extension
@Symbol("maven")
public static final class Maven.DescriptorImpl
extends BuildStepDescriptor<Builder>
implements PersistentDescriptor

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
GlobalSettingsProvider	getDefaultGlobalSettingsProvider()
SettingsProvider	getDefaultSettingsProvider()
String	getDisplayName()	Human readable name of this kind of configurable object.
String	getHelpFile(String fieldName)	Returns the path to the help screen HTML for the given field.
Maven.MavenInstallation[]	getInstallations()
boolean	isApplicable(Class<? extends AbstractProject> jobType)	Returns true if this task is applicable to the given project.
Builder	newInstance(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)	Creates a configured instance from the submitted form.
void	setInstallations(Maven.MavenInstallation... installations)

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

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, 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

Methods inherited from interface hudson.model.PersistentDescriptor

load

Methods inherited from interface hudson.model.Saveable

save

Constructor Detail

DescriptorImpl

public DescriptorImpl()

Method Detail

isApplicable

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

Description copied from class: BuildStepDescriptor

Returns true if this task is applicable to the given project.

Specified by:

isApplicable in class BuildStepDescriptor<Builder>

Returns:

true to allow user to configure this post-promotion task for the given project.

See Also:

AbstractProject.AbstractProjectDescriptor.isApplicable(Descriptor)

getHelpFile

public String getHelpFile(String fieldName)

Description copied from class: Descriptor

Returns the path to the help screen HTML for the given field.

The help files are assumed to be at "help/FIELDNAME.html" with possible locale variations.

Overrides:

getHelpFile in class Descriptor<Builder>

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<Builder>

getDefaultGlobalSettingsProvider

public GlobalSettingsProvider getDefaultGlobalSettingsProvider()

getDefaultSettingsProvider

public SettingsProvider getDefaultSettingsProvider()

getInstallations

public Maven.MavenInstallation[] getInstallations()

setInstallations

public void setInstallations(Maven.MavenInstallation... installations)

newInstance

public Builder 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 Descriptor<Builder>

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.

Throws:

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