Package jenkins.console

Class ConsoleUrlProviderUserProperty.DescriptorImpl

java.lang.Object
hudson.model.Descriptor<UserProperty>
hudson.model.UserPropertyDescriptor
jenkins.console.ConsoleUrlProviderUserProperty.DescriptorImpl
All Implemented Interfaces:
Saveable, Loadable, OnMaster
Enclosing class:
ConsoleUrlProviderUserProperty
@Extension @Symbol("consoleUrlProvider") public static class ConsoleUrlProviderUserProperty.DescriptorImpl extends UserPropertyDescriptor

  • Constructor Details

    • DescriptorImpl

      public DescriptorImpl()

  • Method Details

    • getDisplayName

      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>

    • getDescription

      public String getDescription()
      Description copied from class: UserPropertyDescriptor
      Optional description for the configurable object Displays as plain text
      Overrides:
      getDescription in class UserPropertyDescriptor

    • 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