Package hudson.model

Class MyViewsProperty.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<UserProperty>

hudson.model.UserPropertyDescriptor

hudson.model.MyViewsProperty.DescriptorImpl

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Enclosing class:

MyViewsProperty

@Extension
@Symbol("myView")
public static class MyViewsProperty.DescriptorImpl
extends UserPropertyDescriptor

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.
UserPropertyCategory	getUserPropertyCategory()	Define the category for this user property descriptor.
UserProperty	newInstance(User user)	Creates a default instance of UserProperty to be associated with User object that wasn't created from a persisted XML data.

Methods inherited from class hudson.model.UserPropertyDescriptor

getUserPropertyCategoryAsString, isEnabled

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

DescriptorImpl

public DescriptorImpl()

Method Details

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

newInstance

public UserProperty newInstance(User user)

Description copied from class: UserPropertyDescriptor

Creates a default instance of UserProperty to be associated with User object that wasn't created from a persisted XML data.

See User class javadoc for more details about the life cycle of User and when this method is invoked.

Specified by:

newInstance in class UserPropertyDescriptor

Returns:

null if the implementation choose not to add any property object for such user.

getUserPropertyCategory

@NonNull
public UserPropertyCategory getUserPropertyCategory()

Description copied from class: UserPropertyDescriptor

Define the category for this user property descriptor.

Overrides:

getUserPropertyCategory in class UserPropertyDescriptor

Returns:

never null, always the same value for a given instance of Descriptor.