public class WikiMacroParameterDescriptor extends Object implements org.xwiki.rendering.macro.descriptor.ParameterDescriptor
ParameterDescriptor
for describing wiki macro parameters.Constructor and Description |
---|
WikiMacroParameterDescriptor(String id,
String description,
boolean mandatory)
Creates a new
WikiMacroParameterDescriptor instance. |
WikiMacroParameterDescriptor(String id,
String description,
boolean mandatory,
Object defaultValue)
Creates a new
WikiMacroParameterDescriptor instance. |
WikiMacroParameterDescriptor(String id,
String description,
boolean mandatory,
Object defaultValue,
Type parameterType)
Creates a new
WikiMacroParameterDescriptor instance. |
Modifier and Type | Method and Description |
---|---|
Object |
getDefaultValue() |
String |
getDescription() |
String |
getId() |
String |
getName() |
Type |
getParameterType() |
Class<?> |
getType()
Deprecated.
|
boolean |
isMandatory() |
public WikiMacroParameterDescriptor(String id, String description, boolean mandatory)
WikiMacroParameterDescriptor
instance.id
- parameter identifier.description
- parameter description.mandatory
- if the parameter is mandatory.public WikiMacroParameterDescriptor(String id, String description, boolean mandatory, Object defaultValue)
WikiMacroParameterDescriptor
instance.id
- parameter identifier.description
- parameter description.mandatory
- if the parameter is mandatory.defaultValue
- parameter default value.public WikiMacroParameterDescriptor(String id, String description, boolean mandatory, Object defaultValue, Type parameterType)
WikiMacroParameterDescriptor
instance.id
- parameter identifier.description
- parameter description.mandatory
- if the parameter is mandatory.defaultValue
- parameter default value.parameterType
- parameter type.public String getId()
getId
in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor
public String getName()
getName
in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor
public String getDescription()
getDescription
in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor
@Deprecated public Class<?> getType()
getType
in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor
public Type getParameterType()
getParameterType
in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor
public Object getDefaultValue()
getDefaultValue
in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor
public boolean isMandatory()
isMandatory
in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor
Copyright © 2004–2019 XWiki. All rights reserved.