Package org.jenkinsci.plugins.structs.describable

Class DescribableParameter

java.lang.Object
org.jenkinsci.plugins.structs.describable.DescribableParameter
public final class DescribableParameter extends Object
A property of DescribableModel
Author:
Kohsuke Kawaguchi
See Also:

  • Method Details

    • getType

      public ParameterType getType()
      Classification of the type of this parameter.

      Originates from the pipeline plugin and I'm not sure the logic behind this.

    • getRawType

      public Type getRawType()
      The type of this parameter, possibly with generics.

    • getErasedType

      public Class getErasedType()
      Gets the erasure of getRawType()

    • getName

      public String getName()

    • getCapitalizedName

      public String getCapitalizedName()

    • isRequired

      public boolean isRequired()
      True if this parameter is required.

      A parameter set via DataBoundSetter is considered optional. Right now, all the parameters set via DataBoundConstructor is considered mandatory, but this might change in the future.

    • isDeprecated

      public boolean isDeprecated()
      True if this parameter is deprecated.

      A parameter is deprecated if the corresponding DataBoundSetter marked as Deprecated.

    • getHelp

      @CheckForNull public String getHelp() throws IOException
      Loads help defined for this parameter.
      Returns:
      some HTML (in English locale), if available, else null
      Throws:
      IOException
      See Also:

    • toString

      public String toString()
      Overrides:
      toString in class Object