org.xwiki.properties
Interface PropertyDescriptor

All Known Implementing Classes:

DefaultPropertyDescriptor

public interface PropertyDescriptor

Describe a property in a bean.

Since:

2.0M2

Version:

$Id$

Method Summary

java.lang.Object	getDefaultValue()
java.lang.String	getDescription()
java.lang.reflect.Field	getFied()
java.lang.String	getId()
java.lang.String	getName()
java.lang.Class<?>	getPropertyClass() Deprecated. since 3.0M1 use getPropertyType() instead
java.lang.reflect.Type	getPropertyType()
java.lang.reflect.Method	getReadMethod()
java.lang.reflect.Method	getWriteMethod()
boolean	isMandatory()

Method Detail

getId

java.lang.String getId()

Returns:

the identifier of the property.

Since:

2.1M1

getName

java.lang.String getName()

Returns:

the display name of the property.

Since:

2.1M1

getDescription

java.lang.String getDescription()

Returns:

the description of the property.

getPropertyClass

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

Deprecated. since 3.0M1 use getPropertyType() instead

Returns:

the type of the property.

getPropertyType

java.lang.reflect.Type getPropertyType()

Returns:

the type of the property.

Since:

3.0M1

getDefaultValue

java.lang.Object getDefaultValue()

Returns:

the default value of the property.

isMandatory

boolean isMandatory()

Returns:

indicate if the property is mandatory.

getReadMethod

java.lang.reflect.Method getReadMethod()

Returns:

the read method. If null it generally mean that the property is a public field.

getWriteMethod

java.lang.reflect.Method getWriteMethod()

Returns:

the write method. If null it generally mean that the property is a public field.

getFied

java.lang.reflect.Field getFied()

Returns:

the field. If null if generally mean that the property is based on getter/setter.