org.xwiki.filter.descriptor

Interface FilterStreamPropertyDescriptor<T>

All Known Implementing Classes:

DefaultFilterStreamBeanParameterDescriptor

public interface FilterStreamPropertyDescriptor<T>

Defines a filter property.

Since:

6.2M1

Version:

$Id: 96b9d4b6b212f96b1fac56510abc73ff2c233513 $

Method Summary

Modifier and Type	Method and Description
T	getDefaultValue()
String	getDescription()
String	getId()
String	getName()
Type	getType()
boolean	isMandatory()

Method Detail

getId

String getId()

Returns:

the identifier of the property.

getName

String getName()

Returns:

the display name of the property.

getDescription

String getDescription()

Returns:

the description of the property.

getType

Type getType()

Returns:

the type of the property.

getDefaultValue

T getDefaultValue()

Returns:

the default value of the property.

isMandatory

boolean isMandatory()

Returns:

indicate if the property is mandatory.