org.xwiki.wikistream

Interface WikiStreamFactory

All Known Subinterfaces:

BeanInputWikiStreamFactory<P>, BeanOutputWikiStreamFactory<P>, InputWikiStreamFactory, OutputWikiStreamFactory

@Unstable
public interface WikiStreamFactory

WikiStream class should be inherited by all the stream based classes to implement the type and descriptor which describes a wiki stream with list of bean class parameters.

Since:

5.3M2

Version:

$Id: 111375cda9d2e66c562cedca3b4c39d9243d6adf $

Method Summary

Methods

Modifier and Type	Method and Description
WikiStreamDescriptor	getDescriptor()
Collection<Class<?>>	getFilterInterfaces()
WikiStreamType	getType()

Method Detail

getType

WikiStreamType getType()

Returns:

The WikiStreamType, which identifies a wiki stream input and output components using a role hint.

getDescriptor

WikiStreamDescriptor getDescriptor()

Returns:

The WikiStreamDescriptor describes a WikiStream and has the list of bean class parameters or properties.

getFilterInterfaces

Collection<Class<?>> getFilterInterfaces()
                                         throws WikiStreamException

Returns:

the filters supported by this stream factory

Throws:

WikiStreamException - when failing to get filters interfaces