org.xwiki.rendering.macro.descriptor
Interface ParameterDescriptor

All Known Implementing Classes:

DefaultParameterDescriptor

public interface ParameterDescriptor

Define a macro parameter.

Since:

1.7M2

Version:

$Id$

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() Deprecated. since 3.0M1 use getParameterType() instead
boolean	isMandatory()

Method Detail

getId

java.lang.String getId()

Returns:

the identifier of the parameter.

Since:

2.1M1

getName

java.lang.String getName()

Returns:

the display name of the parameter.

Since:

2.1M1

getDescription

java.lang.String getDescription()

Returns:

the description of the parameter.

getType

@Deprecated
java.lang.Class<?> getType()

Deprecated. since 3.0M1 use getParameterType() instead

Returns:

the type of the parameter.

getParameterType

java.lang.reflect.Type getParameterType()

Returns:

the type of the property.

Since:

3.0M1

getDefaultValue

java.lang.Object getDefaultValue()

Returns:

the default value of the parameter.

isMandatory

boolean isMandatory()

Returns:

indicate if the parameter is mandatory.

Since:

1.7