FilterStreamFactory (XWiki Commons - Filter - API 15.0 API)

All Known Subinterfaces:

BeanInputFilterStreamFactory<P>, BeanOutputFilterStreamFactory<P>, InputFilterStreamFactory, OutputFilterStreamFactory

All Known Implementing Classes:

AbstractBeanFilterStreamFactory, AbstractBeanInputFilterStreamFactory, AbstractBeanOutputFilterStreamFactory, AbstractFilterStreamFactory
```
public interface FilterStreamFactory
```
Filter class should be inherited by all the stream based classes to implement the type and descriptor which describes a filter with list of bean class parameters.

Since:

6.2M1

Version:

$Id: bd35719417bb6109a371443b64805b9f66bfa874 $

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`FilterStreamDescriptor`	`getDescriptor()`
`Collection<Class<?>>`	`getFilterInterfaces()`
`FilterStreamType`	`getType()`

- Method Detail
  - getType
```
FilterStreamType getType()
```
    Returns:
    
    The FilterStreamType, which identifies a filter input and output components using a role hint.
  - getDescriptor
```
FilterStreamDescriptor getDescriptor()
```
    Returns:
    
    The FilterDescriptor describes a Filter and has the list of bean class parameters or properties.
  - getFilterInterfaces
```
Collection<Class<?>> getFilterInterfaces()
                                  throws FilterException
```
    Returns:
    
    the filters supported by this stream factory
    
    Throws:
    
    FilterException - when failing to get filters interfaces