public abstract class UserPropertyDescriptor extends Descriptor<UserProperty>
Descriptor
for UserProperty
.Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self
clazz
Modifier | Constructor and Description |
---|---|
protected |
UserPropertyDescriptor()
Infers the type of the corresponding
Describable from the outer class. |
protected |
UserPropertyDescriptor(Class<? extends UserProperty> clazz) |
Modifier and Type | Method and Description |
---|---|
boolean |
isEnabled()
Whether or not the described property is enabled in the current context.
|
abstract 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. |
addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap
protected UserPropertyDescriptor(Class<? extends UserProperty> clazz)
protected UserPropertyDescriptor()
Describable
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.public abstract UserProperty newInstance(User user)
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.
public boolean isEnabled()
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.
Copyright © 2016. All rights reserved.