PropertyDescriptor (XWiki Commons - Properties 13.7 API)

```
public interface PropertyDescriptor
```
Describe a property in a bean.

Since:

2.0M2

Version:

$Id: 415ec77e21dad4eff33851757ef7353f31da38af $

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()`
`Field`	`getFied()` Deprecated. since 4.2M1 use `getField()` instead
`Field`	`getField()`
`default PropertyGroupDescriptor`	`getGroupDescriptor()`
`String`	`getId()`
`String`	`getName()`
`Class<?>`	`getPropertyClass()` Deprecated. since 3.0M1 use `getPropertyType()` instead
`Type`	`getPropertyType()`
`Method`	`getReadMethod()`
`Method`	`getWriteMethod()`
`default boolean`	`isAdvanced()`
`default boolean`	`isDeprecated()`
`default boolean`	`isDisplayHidden()`
`boolean`	`isMandatory()`

- Method Detail
  - getId
```
String getId()
```
    Returns:
    
    the identifier of the property.
    
    Since:
    
    2.1M1
  - getName
```
String getName()
```
    Returns:
    
    the display name of the property.
    
    Since:
    
    2.1M1
  - getDescription
```
String getDescription()
```
    Returns:
    
    the description of the property.
  - getPropertyClass
```
@Deprecated
Class<?> getPropertyClass()
```
    Deprecated. since 3.0M1 use getPropertyType() instead
    
    Returns:
    
    the type of the property.
  - getPropertyType
```
Type getPropertyType()
```
    Returns:
    
    the type of the property.
    
    Since:
    
    3.0M1
  - getDefaultValue
```
Object getDefaultValue()
```
    Returns:
    
    the default value of the property or null if no default value has been defined
  - isMandatory
```
boolean isMandatory()
```
    Returns:
    
    indicate if the property is mandatory.
  - getReadMethod
```
Method getReadMethod()
```
    Returns:
    
    the read method. If null it generally mean that the property is a public field.
  - getWriteMethod
```
Method getWriteMethod()
```
    Returns:
    
    the write method. If null it generally mean that the property is a public field.
  - getFied
```
@Deprecated
Field getFied()
```
    Deprecated. since 4.2M1 use getField() instead
    
    Returns:
    
    the field. If null if generally mean that the property is based on getter/setter.
  - getField
```
Field getField()
```
    Returns:
    
    the field. If null if generally mean that the property is based on getter/setter.
    
    Since:
    
    4.2M1
  - isDeprecated
```
default boolean isDeprecated()
```
    Returns:
    
    indicates if the property is deprecated.
    
    Since:
    
    10.10RC1
  - isAdvanced
```
default boolean isAdvanced()
```
    Returns:
    
    indicates if the property is advanced.
    
    Since:
    
    10.10RC1
  - getGroupDescriptor
```
default PropertyGroupDescriptor getGroupDescriptor()
```
    Returns:
    
    the hierarchy of groups.
    
    Since:
    
    10.11RC1
  - getDisplayType
```
default Type getDisplayType()
```
    Returns:
    
    the type used when displaying the property.
    
    Since:
    
    11.0
  - isDisplayHidden
```
@Unstable
default boolean isDisplayHidden()
```
    Returns:
    
    whether the property should be displayed in UIs or not. For example the WYSIWYG editor uses it to decide whether to display or not a Macro property in the Macro editor UI.
    
    Since:
    
    12.4RC1

Interface PropertyDescriptor

Method Summary

Method Detail

getId

getName

getDescription

getPropertyClass

getPropertyType

getDefaultValue

isMandatory

getReadMethod

getWriteMethod

getFied

getField

isDeprecated

isAdvanced

getGroupDescriptor

getDisplayType

isDisplayHidden