Class DescribableParameter
- java.lang.Object
-
- org.jenkinsci.plugins.structs.describable.DescribableParameter
-
public final class DescribableParameter extends Object
A property ofDescribableModel
- Author:
- Kohsuke Kawaguchi
- See Also:
DescribableModel.getParameter(String)
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getCapitalizedName()
Class
getErasedType()
Gets the erasure ofgetRawType()
String
getHelp()
Loads help defined for this parameter.String
getName()
Type
getRawType()
The type of this parameter, possibly with generics.ParameterType
getType()
Classification of the type of this parameter.boolean
isDeprecated()
True if this parameter is deprecated.boolean
isRequired()
True if this parameter is required.String
toString()
-
-
-
Method Detail
-
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 ofgetRawType()
-
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 viaDataBoundConstructor
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 asDeprecated
.
-
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:
Descriptor.doHelp(org.kohsuke.stapler.StaplerRequest, org.kohsuke.stapler.StaplerResponse)
-
-