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 Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDisplayName()
Corresponds toDescriptor.getDisplayName()
where available.String
getHelp(String parameter)
Loads help defined for this object as a whole or one of its parameters.Class<?>
getType()
A concrete class, usuallyDescribable
.List<String>
mandatoryParameters()
Mandatory (constructor) parameters, in order.Map<String,DescribableHelper.ParameterType>
parameters()
A map from parameter names to types.String
toString()
-
-
-
Method Detail
-
getType
public Class<?> getType()
A concrete class, usuallyDescribable
.
-
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 aDataBoundConstructor
, or the JavaBeans property name corresponding to aDataBoundSetter
.
-
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 useDataBoundSetter
on the type definition). Will be keys inparameters
.
-
getDisplayName
public String getDisplayName()
Corresponds toDescriptor.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 useUtil.replaceMacro(String, Map)
to replace${rootURL}
with some other value.- Parameters:
parameter
- if specified, one ofparameters
; else for the whole object- Returns:
- some HTML (in English locale), if available, else null
- Throws:
IOException
- See Also:
Descriptor.doHelp(org.kohsuke.stapler.StaplerRequest, org.kohsuke.stapler.StaplerResponse)
-
-