Package hudson.tools

Class ToolLocationNodeProperty.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<P>

hudson.tools.PropertyDescriptor<NodeProperty<?>,Node>

hudson.slaves.NodePropertyDescriptor

hudson.tools.ToolLocationNodeProperty.DescriptorImpl

All Implemented Interfaces:

Saveable, OnMaster

Enclosing class:

ToolLocationNodeProperty

@Extension
@Symbol("toolLocation")
public static class ToolLocationNodeProperty.DescriptorImpl
extends NodePropertyDescriptor

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.
String	getKey(ToolInstallation installation)
DescriptorExtensionList<ToolInstallation,ToolDescriptor<?>>	getToolDescriptors()
boolean	isApplicable(Class<? extends Node> nodeType)	Returns true if this property type is applicable to the given target type.

Methods inherited from class hudson.slaves.NodePropertyDescriptor

isApplicableAsGlobal

Methods inherited from class hudson.tools.PropertyDescriptor

for_, for_

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

getToolDescriptors

public DescriptorExtensionList<ToolInstallation,ToolDescriptor<?>> getToolDescriptors()

getKey

public String getKey(ToolInstallation installation)

isApplicable

public boolean isApplicable(Class<? extends Node> nodeType)

Description copied from class: PropertyDescriptor

Returns true if this property type is applicable to the given target type.

The default implementation of this method checks if the given node type is assignable according to the parameterization, but subtypes can extend this to change this behavior.

Overrides:

isApplicable in class PropertyDescriptor<NodeProperty<?>,Node>

Returns:

true to indicate applicable, in which case the property will be displayed in the configuration screen of the target, for example.