Package hudson.model

Class TimeZoneProperty.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<UserProperty>

hudson.model.UserPropertyDescriptor

hudson.model.TimeZoneProperty.DescriptorImpl

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Enclosing class:

TimeZoneProperty

@Extension
@Symbol("timezone")
public static class TimeZoneProperty.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
FormValidation	doCheckTimeZoneName(String timeZoneName)
ListBoxModel	doFillTimeZoneNameItems(User user)
String	getDisplayName()	Human readable name of this kind of configurable object.
boolean	isEnabled()	Whether or not the described property is enabled in the current context.
void	load()	Loads the data from the disk into this object.
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.
void	save()	Saves the configuration info to the disk.

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, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, 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<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.

load

public void load()

Description copied from class: Descriptor

Loads the data from the disk into this object.

The constructor of the derived class must call this method. (If we do that in the base class, the derived class won't get a chance to set default values.)

Specified by:

load in interface Loadable

Overrides:

load in class Descriptor<UserProperty>

save

public void save()

Description copied from class: Descriptor

Saves the configuration info to the disk.

Specified by:

save in interface Saveable

Overrides:

save in class Descriptor<UserProperty>

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

doFillTimeZoneNameItems

public ListBoxModel doFillTimeZoneNameItems(@AncestorInPath
                                            User user)

doCheckTimeZoneName

public FormValidation doCheckTimeZoneName(@QueryParameter
                                          String timeZoneName)