Package hudson.model

Class UserPropertyDescriptor

java.lang.Object
hudson.model.Descriptor<UserProperty>
hudson.model.UserPropertyDescriptor
All Implemented Interfaces:
Saveable, Loadable, OnMaster
Direct Known Subclasses:
ApiTokenProperty.DescriptorImpl, ConsoleUrlProviderUserProperty.DescriptorImpl, HudsonPrivateSecurityRealm.Details.DescriptorImpl, LastGrantedAuthoritiesProperty.DescriptorImpl, MyViewsProperty.DescriptorImpl, PaneStatusProperties.DescriptorImpl, TimeZoneProperty.DescriptorImpl, UserExperimentalFlagsProperty.DescriptorImpl, UserSearchProperty.DescriptorImpl, UserSeedProperty.DescriptorImpl
public abstract class UserPropertyDescriptor extends Descriptor<UserProperty>
Descriptor for UserProperty.
Author:
Kohsuke Kawaguchi

  • Constructor Details

    • UserPropertyDescriptor

      protected UserPropertyDescriptor(Class<? extends UserProperty> clazz)

    • UserPropertyDescriptor

      protected UserPropertyDescriptor()
      Infers the type of the corresponding 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.
      Since:
      1.278

  • Method Details

    • newInstance

      public 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.

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

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

    • isEnabled

      public boolean isEnabled()
      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.

    • getUserPropertyCategory

      @NonNull public UserPropertyCategory getUserPropertyCategory()
      Define the category for this user property descriptor.
      Returns:
      never null, always the same value for a given instance of Descriptor.
      Since:
      2.468

    • getUserPropertyCategoryAsString

      @Deprecated @CheckForNull protected String getUserPropertyCategoryAsString()
      Deprecated.
      This should only be used when the core requirement is below the version this method was added
      Method proposed to prevent plugins to rely on too recent core version while keeping the possibility to use the categories.
      Returns:
      String name corresponding to the symbol of getUserPropertyCategory()
      Since:
      2.468

    • getDescription

      @Nullable public String getDescription()
      Optional description for the configurable object Displays as plain text
      Since:
      2.477