Package hudson.model

Class PaneStatusProperties.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<UserProperty>

hudson.model.UserPropertyDescriptor

hudson.model.PaneStatusProperties.DescriptorImpl

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Enclosing class:

PaneStatusProperties

@Extension
@Symbol("paneStatus")
public static class PaneStatusProperties.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
UserPropertyCategory	getUserPropertyCategory()	Define the category for this user property descriptor.
boolean	isEnabled()	Whether or not the described property is enabled in the current context.
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

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

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.

isEnabled

public boolean isEnabled()

Description copied from class: UserPropertyDescriptor

Whether or not the described property is enabled in the current context. Defaults to true. Over-ride in sub-classes as required.

Returning false from this method essentially has the same effect of making Hudson behaves as if this UserPropertyDescriptor is not a part of UserProperty.all().

This mechanism is useful if the availability of the property is contingent of some other settings.

Overrides:

isEnabled in class UserPropertyDescriptor

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.