Package org.xwiki.rendering.macro.wikibridge

Class WikiMacroParameterDescriptor

java.lang.Object

org.xwiki.rendering.macro.wikibridge.WikiMacroParameterDescriptor

All Implemented Interfaces:

org.xwiki.rendering.macro.descriptor.ParameterDescriptor

public class WikiMacroParameterDescriptor
extends Object
implements org.xwiki.rendering.macro.descriptor.ParameterDescriptor

ParameterDescriptor for describing wiki macro parameters.

Since:

2.0M2

Version:

$Id: 2a56c1d25f3822ef61c39d861b3cdce0fae92f66 $

Constructor Summary

Constructors

Constructor	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.

Method Summary

Modifier and Type	Method	Description
Object	getDefaultValue()
String	getDescription()
String	getId()
String	getName()
Type	getParameterType()
Class<?>	getType()	Deprecated.
boolean	isMandatory()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor

getDisplayType, getGroupDescriptor, isAdvanced, isDeprecated, isDisplayHidden

Constructor Detail

WikiMacroParameterDescriptor

public WikiMacroParameterDescriptor(String id,
                                    String description,
                                    boolean mandatory)

Creates a new WikiMacroParameterDescriptor instance.

Parameters:

id - parameter identifier.

description - parameter description.

mandatory - if the parameter is mandatory.

WikiMacroParameterDescriptor

public WikiMacroParameterDescriptor(String id,
                                    String description,
                                    boolean mandatory,
                                    Object defaultValue)

Creates a new WikiMacroParameterDescriptor instance.

Parameters:

id - parameter identifier.

description - parameter description.

mandatory - if the parameter is mandatory.

defaultValue - parameter default value.

Since:

2.3M1

WikiMacroParameterDescriptor

public WikiMacroParameterDescriptor(String id,
                                    String description,
                                    boolean mandatory,
                                    Object defaultValue,
                                    Type parameterType)

Creates a new WikiMacroParameterDescriptor instance.

Parameters:

id - parameter identifier.

description - parameter description.

mandatory - if the parameter is mandatory.

defaultValue - parameter default value.

parameterType - parameter type.

Since:

10.10RC1

Method Detail

getId

public String getId()

Specified by:

getId in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor

getName

public String getName()

Specified by:

getName in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor

getDescription

public String getDescription()

Specified by:

getDescription in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor

getType

@Deprecated
public Class<?> getType()

Deprecated.

Specified by:

getType in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor

getParameterType

public Type getParameterType()

Specified by:

getParameterType in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor

getDefaultValue

public Object getDefaultValue()

Specified by:

getDefaultValue in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor

isMandatory

public boolean isMandatory()

Specified by:

isMandatory in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor