AbstractBeanFilterStreamFactory (XWiki Commons - Filter - API 15.0 API)

java.lang.Object
- org.xwiki.filter.AbstractFilterStreamFactory
- - org.xwiki.filter.AbstractBeanFilterStreamFactory<P>

Type Parameters:

P - the type of the class containing the parameters of the filter

All Implemented Interfaces:

Initializable, FilterStreamFactory

Direct Known Subclasses:

AbstractBeanInputFilterStreamFactory, AbstractBeanOutputFilterStreamFactory
```
public abstract class AbstractBeanFilterStreamFactory<P>
extends AbstractFilterStreamFactory
implements FilterStreamFactory, Initializable
```
Since:

6.2M1

Version:

$Id: ecf60442a209e2bf2b004bad900ead51d065d405 $

Field Summary

Fields
Modifier and Type Field Description

protected BeanManager beanManager
The BeanManager component.
- Fields inherited from class org.xwiki.filter.AbstractFilterStreamFactory
  descriptor, type

Constructor Summary

Constructors
Constructor Description

AbstractBeanFilterStreamFactory(FilterStreamType type)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected P`	`createPropertiesBean(Map<String,Object> properties)`
`String`	`getDescription()`
`String`	`getName()`
`Class<P>`	`getPropertiesBeanClass()`
`void`	`initialize()`
`void`	`setDescription(String description)`
`void`	`setName(String name)`
`void`	`setPropertiesBeanClass(Class<P> propertiesBeanClass)`

Methods inherited from class org.xwiki.filter.AbstractFilterStreamFactory
getDescriptor, getType, setDescriptor

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xwiki.filter.FilterStreamFactory
getDescriptor, getFilterInterfaces, getType

Field Detail
- beanManager
```
@Inject
protected BeanManager beanManager
```
  The BeanManager component.

Constructor Detail

AbstractBeanFilterStreamFactory

public AbstractBeanFilterStreamFactory(FilterStreamType type)

Method Detail

initialize
```
public void initialize()
                throws InitializationException
```
Specified by:

initialize in interface Initializable

Throws:

InitializationException

createPropertiesBean

protected P createPropertiesBean(Map<String,Object> properties)
                          throws FilterException

Throws:: FilterException

setName
```
public void setName(String name)
```
Parameters:

name - the name to set

getName
```
public String getName()
```
Returns:

the name

setDescription
```
public void setDescription(String description)
```
Parameters:

description - the description to set

getDescription
```
public String getDescription()
```
Returns:

the description

setPropertiesBeanClass
```
public void setPropertiesBeanClass(Class<P> propertiesBeanClass)
```
Parameters:

propertiesBeanClass - the parametersBeanClass to set

getPropertiesBeanClass
```
public Class<P> getPropertiesBeanClass()
```
Returns:

the properties bean class