FilterStreamDescriptor (XWiki Commons - Filter - API 15.10.12 API)

All Known Subinterfaces:

FilterStreamBeanDescriptor

All Known Implementing Classes:

AbstractFilterStreamDescriptor, CompositeFilterStreamDescriptor, DefaultFilterStreamBeanDescriptor
```
public interface FilterStreamDescriptor
```
Describes a filter stream.

Since:

6.2M1

Version:

$Id: 4cf9218e9fc6d460eccf27b605b4c5737542aeb8 $

Method Summary

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

- Method Detail
  - getName
```
String getName()
```
    Returns:
    
    human readable name of filter input source type.
  - getDescription
```
String getDescription()
```
    Returns:
    
    the description of the filter
  - getPropertyDescriptor
```
<T> FilterStreamPropertyDescriptor<T> getPropertyDescriptor(String propertyName)
```
    Return descriptor for the provided property name. The property name is not case sensitive.
    
    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
```
Collection<FilterStreamPropertyDescriptor<?>> getProperties()
```
    Returns:
    
    the properties of filter.