Package hudson.model

Class ParameterDefinition.ParameterDescriptor

java.lang.Object

hudson.model.Descriptor<ParameterDefinition>

hudson.model.ParameterDefinition.ParameterDescriptor

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Direct Known Subclasses:

BooleanParameterDefinition.DescriptorImpl, ChoiceParameterDefinition.DescriptorImpl, FileParameterDefinition.DescriptorImpl, PasswordParameterDefinition.ParameterDescriptorImpl, RunParameterDefinition.DescriptorImpl, StringParameterDefinition.DescriptorImpl, TextParameterDefinition.DescriptorImpl

Enclosing class:

ParameterDefinition

public abstract static class ParameterDefinition.ParameterDescriptor
extends Descriptor<ParameterDefinition>

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

Modifier	Constructor	Description
protected	ParameterDescriptor()	Infers the type of the corresponding ParameterDefinition.ParameterDescriptor from the outer class.
protected	ParameterDescriptor(Class<? extends ParameterDefinition> klazz)

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()	Human readable name of this kind of configurable object.
String	getValuePage()

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

ParameterDescriptor

protected ParameterDescriptor(Class<? extends ParameterDefinition> klazz)

ParameterDescriptor

protected ParameterDescriptor()

Infers the type of the corresponding ParameterDefinition.ParameterDescriptor from the outer class. This version works when you follow the common convention, where a descriptor is written as the static nested class of the describable class.

Since:

1.278

Method Details

getValuePage

public String getValuePage()

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