org.xwiki.filter.descriptor

Class AbstractFilterStreamDescriptor

java.lang.Object

org.xwiki.filter.descriptor.AbstractFilterStreamDescriptor

All Implemented Interfaces:

FilterStreamDescriptor

Direct Known Subclasses:

CompositeFilterStreamDescriptor, DefaultFilterStreamBeanDescriptor

public abstract class AbstractFilterStreamDescriptor
extends Object
implements FilterStreamDescriptor

Since:

6.2M1

Version:

$Id: 74ef985030fa0b3a22bcc2c1be27a9eecccc6736 $

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description The description of the macro.
protected String	name
protected Map<String,FilterStreamPropertyDescriptor<?>>	parameterDescriptorMap A map containing the FilterStreamPropertyDescriptor for each parameters supported for this filter.

Constructor Summary

Constructors

Constructor and Description
AbstractFilterStreamDescriptor(String name, String description)

Method Summary

Modifier and Type	Method and Description
String	getDescription()
String	getName()
Collection<FilterStreamPropertyDescriptor<?>>	getProperties()
<T> FilterStreamPropertyDescriptor<T>	getPropertyDescriptor(String propertyName) Return descriptor for the provided property name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

protected String name

See Also:

getName()

description

protected String description

The description of the macro.

parameterDescriptorMap

protected Map<String,FilterStreamPropertyDescriptor<?>> parameterDescriptorMap

A map containing the FilterStreamPropertyDescriptor for each parameters supported for this filter.

The Map keys are lower cased for easier case insensitive search, to get the "real" name of the property use FilterStreamPropertyDescriptor.getName().

Constructor Detail

AbstractFilterStreamDescriptor

public AbstractFilterStreamDescriptor(String name,
                                      String description)

Parameters:

name - human readable name of filter input source type.

description - the description of the filter

Method Detail

getName

public String getName()

Specified by:

getName in interface FilterStreamDescriptor

Returns:

human readable name of filter input source type.

getDescription

public String getDescription()

Specified by:

getDescription in interface FilterStreamDescriptor

Returns:

the description of the filter

getPropertyDescriptor

public <T> FilterStreamPropertyDescriptor<T> getPropertyDescriptor(String propertyName)

Description copied from interface: FilterStreamDescriptor

Return descriptor for the provided property name. The property name is not case sensitive.

Specified by:

getPropertyDescriptor in interface FilterStreamDescriptor

Type Parameters:

T - the type of value associated to this property

Parameters:

propertyName - the name of the property

Returns:

the descriptor of the property.

getProperties

public Collection<FilterStreamPropertyDescriptor<?>> getProperties()

Specified by:

getProperties in interface FilterStreamDescriptor

Returns:

the properties of filter.