Package hudson.model

Class FileParameterDefinition.DescriptorImpl

All Implemented Interfaces:
Saveable, Loadable, OnMaster
Enclosing class:

@Extension @Symbol({"file","fileParam"}) public static class FileParameterDefinition.DescriptorImpl extends ParameterDefinition.ParameterDescriptor
  • Constructor Details

    • DescriptorImpl

      public DescriptorImpl()
  • Method Details

    • 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.
      getDisplayName in class ParameterDefinition.ParameterDescriptor
    • getHelpFile

      public String getHelpFile()
      Description copied from class: Descriptor
      Returns the resource path to the help screen HTML, if any.

      Starting 1.282, this method uses "convention over configuration" — you should just put the "help.html" (and its localized versions, if any) in the same directory you put your Jelly view files, and this method will automatically does the right thing.

      This value is relative to the context root of Hudson, so normally the values are something like "/plugin/emma/help.html" to refer to static resource files in a plugin, or "/publisher/EmmaPublisher/abc" to refer to Jelly script abc.jelly or a method EmmaPublisher.doAbc().

      getHelpFile in class Descriptor<ParameterDefinition>
      null to indicate that there's no help.