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:

DescribableModel.getParameter(String)

Method Summary

Methods

Modifier and Type	Method and Description
String	getCapitalizedName()
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()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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.

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:

Descriptor.doHelp(org.kohsuke.stapler.StaplerRequest, org.kohsuke.stapler.StaplerResponse)

toString

public String toString()

Overrides:

toString in class Object