ParameterDescriptor (XWiki Rendering - Transformation

All Known Implementing Classes:

DefaultParameterDescriptor
```
public interface ParameterDescriptor
```
Define a macro parameter.

Since:

1.7M2

Version:

$Id: 491f7529790bc4cd21793e3cc93de8eae887540a $

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`Object`	`getDefaultValue()`
`String`	`getDescription()`
`default Type`	`getDisplayType()`
`default org.xwiki.properties.PropertyGroupDescriptor`	`getGroupDescriptor()`
`String`	`getId()`
`String`	`getName()`
`Type`	`getParameterType()`
`Class<?>`	`getType()` Deprecated. since 3.0M1 use `getParameterType()` instead
`default boolean`	`isAdvanced()`
`default boolean`	`isDeprecated()`
`default boolean`	`isDisplayHidden()`
`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
  - isDeprecated
```
default boolean isDeprecated()
```
    Returns:
    
    indicate if the parameter is deprecated.
    
    Since:
    
    10.10RC1
  - isAdvanced
```
default boolean isAdvanced()
```
    Returns:
    
    indicate if the parameter is advanced.
    
    Since:
    
    10.10RC1
  - getGroupDescriptor
```
default org.xwiki.properties.PropertyGroupDescriptor getGroupDescriptor()
```
    Returns:
    
    a hierarchy of groups and its associated feature.
    
    Since:
    
    10.11RC1
  - getDisplayType
```
default Type getDisplayType()
```
    Returns:
    
    the type used to display the property.
    
    Since:
    
    11.0
  - isDisplayHidden
```
@Unstable
default boolean isDisplayHidden()
```
    Returns:
    
    whether the parameter should be displayed in UIs or not. For example the WYSIWYG editor uses it to decide whether to display it or not in the Macro editor UI.
    
    Since:
    
    12.4RC1

Interface ParameterDescriptor

Method Summary

Method Detail

getId

getName

getDescription

getType

getParameterType

getDefaultValue

isMandatory

isDeprecated

isAdvanced

getGroupDescriptor

getDisplayType

isDisplayHidden