org.xwiki.rendering.macro.descriptor

Interface ParameterDescriptor

All Known Implementing Classes:

DefaultParameterDescriptor

public interface ParameterDescriptor

Define a macro parameter.

Since:

1.7M2

Version:

$Id: d4079c7a4cbdc55fd007d0f201dd16263a66b09f $

Method Summary

Methods

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

Method Detail

getId

String getId()

Returns:

the identifier of the parameter.

Since:

2.1M1

getName

String getName()

Returns:

the display name of the parameter.

Since:

2.1M1

getDescription

String getDescription()

Returns:

the description of the parameter.

getType

@Deprecated
Class<?> getType()

Deprecated. since 3.0M1 use getParameterType() instead

Returns:

the type of the parameter.

getParameterType

Type getParameterType()

Returns:

the type of the property.

Since:

3.0M1

getDefaultValue

Object getDefaultValue()

Returns:

the default value of the parameter.

isMandatory

boolean isMandatory()

Returns:

indicate if the parameter is mandatory.

Since:

1.7