org.xwiki.properties

Interface PropertyDescriptor

public interface PropertyDescriptor

Describe a property in a bean.

Since:

2.0M2

Version:

$Id: f6e42a048d63234857195ed28ead0d2d315e3988 $

Method Summary

Methods

Modifier and Type	Method and Description
Object	getDefaultValue()
String	getDescription()
Field	getFied() Deprecated. since 4.2M1 use getField() instead
Field	getField()
String	getId()
String	getName()
Class<?>	getPropertyClass() Deprecated. since 3.0M1 use getPropertyType() instead
Type	getPropertyType()
Method	getReadMethod()
Method	getWriteMethod()
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.

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