Package org.apache.maven.doxia.sink.impl

Class BufferingSinkProxyFactory

java.lang.Object

org.apache.maven.doxia.sink.impl.BufferingSinkProxyFactory

All Implemented Interfaces:

SinkWrapperFactory

public class BufferingSinkProxyFactory
extends Object
implements SinkWrapperFactory

Buffers all method calls on the proxied Sink until its Sink.flush() is called.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BufferingSinkProxyFactory.BufferingSink

Constructor Summary

Constructors

Constructor	Description
BufferingSinkProxyFactory()

Method Summary

Modifier and Type	Method	Description
static BufferingSinkProxyFactory.BufferingSink	castAsBufferingSink(Sink sink)
Sink	createWrapper(Sink delegate)	By default all wrappers just delegate each method to the wrapped sink's method.
int	getPriority()	Determines the order of sink wrappers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BufferingSinkProxyFactory

public BufferingSinkProxyFactory()

Method Details

createWrapper

public Sink createWrapper(Sink delegate)

Description copied from interface: SinkWrapperFactory

By default all wrappers just delegate each method to the wrapped sink's method. For certain Sink methods the wrapper may modify the sink before/after or instead of calling the delegate's method.

Specified by:

createWrapper in interface SinkWrapperFactory

Parameters:

delegate - the delegate

Returns:

a new sink wrapping the given one

castAsBufferingSink

public static BufferingSinkProxyFactory.BufferingSink castAsBufferingSink(Sink sink)

getPriority

public int getPriority()

Description copied from interface: SinkWrapperFactory

Determines the order of sink wrappers. The wrapper factory with the highest priority is called first.

Specified by:

getPriority in interface SinkWrapperFactory

Returns:

the priority of this factory