Package hudson.tasks

Class Maven.MavenInstallation.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<ToolInstallation>

hudson.tools.ToolDescriptor<Maven.MavenInstallation>

hudson.tasks.Maven.MavenInstallation.DescriptorImpl

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Enclosing class:

Maven.MavenInstallation

@Extension
@Symbol("maven")
public static class Maven.MavenInstallation.DescriptorImpl
extends ToolDescriptor<Maven.MavenInstallation>

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
protected FormValidation	checkHomeDirectory(File value)	Checks if the MAVEN_HOME is valid.
List<? extends ToolInstaller>	getDefaultInstallers()	Optional list of installers to be configured by default for new tools of this type.
String	getDisplayName()	Human readable name of this kind of configurable object.
Maven.MavenInstallation[]	getInstallations()	Configured instances of ToolInstallations.
void	setInstallations(Maven.MavenInstallation... installations)	Overwrites ToolInstallations.

Methods inherited from class hudson.tools.ToolDescriptor

configure, doCheckHome, doCheckName, getCategory, getDefaultProperties, getPropertyDescriptors

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, 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

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

getDefaultInstallers

public List<? extends ToolInstaller> getDefaultInstallers()

Description copied from class: ToolDescriptor

Optional list of installers to be configured by default for new tools of this type. If there are popular versions of the tool available using generic installation techniques, they can be returned here for the user's convenience.

Overrides:

getDefaultInstallers in class ToolDescriptor<Maven.MavenInstallation>

getInstallations

public Maven.MavenInstallation[] getInstallations()

Description copied from class: ToolDescriptor

Configured instances of ToolInstallations.

Overrides:

getInstallations in class ToolDescriptor<Maven.MavenInstallation>

Returns:

read-only list of installations; can be empty but never null.

setInstallations

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

Description copied from class: ToolDescriptor

Overwrites ToolInstallations.

Overrides:

setInstallations in class ToolDescriptor<Maven.MavenInstallation>

Parameters:

installations - list of installations; can be empty but never null.

checkHomeDirectory

protected FormValidation checkHomeDirectory(File value)

Checks if the MAVEN_HOME is valid.

Overrides:

checkHomeDirectory in class ToolDescriptor<Maven.MavenInstallation>

Parameters:

value - a possible value for ToolInstallation.getHome(), known to already exist on the controller TODO(terminology) or is it built-in?

Returns:

by default, FormValidation.ok()