Package org.xwiki.filter.output

Class AbstractBeanOutputFilterStreamFactory<P,F>

java.lang.Object

org.xwiki.filter.AbstractFilterStreamFactory

org.xwiki.filter.AbstractBeanFilterStreamFactory<P>

org.xwiki.filter.output.AbstractBeanOutputFilterStreamFactory<P,F>

Type Parameters:

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

All Implemented Interfaces:

Initializable, FilterStreamFactory, BeanOutputFilterStreamFactory<P>, OutputFilterStreamFactory

public abstract class AbstractBeanOutputFilterStreamFactory<P,F>
extends AbstractBeanFilterStreamFactory<P>
implements BeanOutputFilterStreamFactory<P>

Since:

6.2M1

Version:

$Id: feae1eb47345f3c9a976e4afcc65ff31ae30a7b9 $

Field Summary

Fields inherited from class org.xwiki.filter.AbstractBeanFilterStreamFactory

beanManager

Fields inherited from class org.xwiki.filter.AbstractFilterStreamFactory

descriptor, type

Constructor Summary

Constructors

Constructor	Description
AbstractBeanOutputFilterStreamFactory(FilterStreamType type)

Method Summary

Modifier and Type	Method	Description
OutputFilterStream	createOutputFilterStream(Map<String,Object> properties)
BeanOutputFilterStream<P>	createOutputFilterStream(P properties)
Collection<Class<?>>	getFilterInterfaces()
void	initialize()

Methods inherited from class org.xwiki.filter.AbstractBeanFilterStreamFactory

createPropertiesBean, getDescription, getName, getPropertiesBeanClass, setDescription, setName, setPropertiesBeanClass

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, getType

Constructor Detail

AbstractBeanOutputFilterStreamFactory

public AbstractBeanOutputFilterStreamFactory(FilterStreamType type)

Method Detail

initialize

public void initialize()
                throws InitializationException

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AbstractBeanFilterStreamFactory<P>

Throws:

InitializationException

getFilterInterfaces

public Collection<Class<?>> getFilterInterfaces()
                                         throws FilterException

Specified by:

getFilterInterfaces in interface FilterStreamFactory

Returns:

the filters supported by this stream factory

Throws:

FilterException - when failing to get filters interfaces

createOutputFilterStream

public OutputFilterStream createOutputFilterStream(Map<String,Object> properties)
                                            throws FilterException

Specified by:

createOutputFilterStream in interface OutputFilterStreamFactory

Parameters:

properties - the properties to control OutputFilterStream behavior

Returns:

a new OutputFilterStream

Throws:

FilterException - when failing to create a OutputFilterStream

createOutputFilterStream

public BeanOutputFilterStream<P> createOutputFilterStream(P properties)
                                                   throws FilterException

Specified by:

createOutputFilterStream in interface BeanOutputFilterStreamFactory<P>

Parameters:

properties - the properties to control OutputFilterStream behavior

Returns:

a new OutputFilterStream

Throws:

FilterException - when failing to create a OutputFilterStream