public static final class DescribableHelper.Schema extends Object
Modifier and Type | Method and Description |
---|---|
String |
getDisplayName()
Corresponds to
Descriptor.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, usually
Describable . |
List<String> |
mandatoryParameters()
Mandatory (constructor) parameters, in order.
|
Map<String,DescribableHelper.ParameterType> |
parameters()
A map from parameter names to types.
|
String |
toString() |
public Class<?> getType()
Describable
.public Map<String,DescribableHelper.ParameterType> parameters()
DataBoundConstructor
,
or the JavaBeans property name corresponding to a DataBoundSetter
.public List<String> mandatoryParameters()
DataBoundSetter
on the type definition).
Will be keys in parameters
.public String getDisplayName()
Descriptor.getDisplayName()
where available.@CheckForNull public String getHelp(@CheckForNull String parameter) throws IOException
Util.replaceMacro(String, Map)
to replace ${rootURL}
with some other value.parameter
- if specified, one of parameters
; else for the whole objectIOException
Descriptor.doHelp(org.kohsuke.stapler.StaplerRequest, org.kohsuke.stapler.StaplerResponse)
Copyright © 2016–2017. All rights reserved.