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 java.lang.Object
implements org.xwiki.rendering.macro.descriptor.ParameterDescriptor

ParameterDescriptor for describing wiki macro parameters.

Since:

2.0M2

Version:

$Id$

Constructor Summary

WikiMacroParameterDescriptor(java.lang.String id, java.lang.String description, boolean mandatory)
Creates a new WikiMacroParameterDescriptor instance.

WikiMacroParameterDescriptor(java.lang.String id, java.lang.String description, boolean mandatory, java.lang.Object defaultValue)
Creates a new WikiMacroParameterDescriptor instance.

Method Summary

java.lang.Object	getDefaultValue()
java.lang.String	getDescription()
java.lang.String	getId()
java.lang.String	getName()
java.lang.reflect.Type	getParameterType()
java.lang.Class<?>	getType()
boolean	isMandatory()

Methods inherited from class java.lang.Object

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

Constructor Detail

WikiMacroParameterDescriptor

public WikiMacroParameterDescriptor(java.lang.String id,
                                    java.lang.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(java.lang.String id,
                                    java.lang.String description,
                                    boolean mandatory,
                                    java.lang.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

Method Detail

getId

public java.lang.String getId()

Specified by:

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

getName

public java.lang.String getName()

Specified by:

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

See Also:

ParameterDescriptor.getName()

getDescription

public java.lang.String getDescription()

Specified by:

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

getType

public java.lang.Class<?> getType()

Specified by:

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

getParameterType

public java.lang.reflect.Type getParameterType()

Specified by:

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

See Also:

ParameterDescriptor.getParameterType()

getDefaultValue

public java.lang.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