Package org.jenkinsci.plugins.workflow.structs

Class DescribableHelper.Schema

java.lang.Object
org.jenkinsci.plugins.workflow.structs.DescribableHelper.Schema
Enclosing class:
DescribableHelper
public static final class DescribableHelper.Schema extends Object
Definition of how a particular class may be configured.

  • Method Details

    • getType

      public Class<?> getType()
      A concrete class, usually Describable.

    • parameters

      public Map<String,DescribableHelper.ParameterType> parameters()
      A map from parameter names to types. A parameter name is either the name of an argument to a DataBoundConstructor, or the JavaBeans property name corresponding to a DataBoundSetter.

    • mandatoryParameters

      public List<String> mandatoryParameters()
      Mandatory (constructor) parameters, in order. Parameters at the end of the list may be omitted, in which case they are assumed to be null or some other default value (in these cases it would be better to use DataBoundSetter on the type definition). Will be keys in parameters.

    • getDisplayName

      public String getDisplayName()
      Corresponds to Descriptor.getDisplayName() where available.

    • getHelp

      @CheckForNull public String getHelp(@CheckForNull String parameter) throws IOException
      Loads help defined for this object as a whole or one of its parameters. Note that you may need to use Util.replaceMacro(String, Map) to replace ${rootURL} with some other value.
      Parameters:
      parameter - if specified, one of parameters; else for the whole object
      Returns:
      some HTML (in English locale), if available, else null
      Throws:
      IOException
      See Also:

    • toString

      public String toString()
      Overrides:
      toString in class Object