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

Class AbstractBinarySinkFactory

java.lang.Object

org.apache.maven.doxia.sink.impl.AbstractBinarySinkFactory

All Implemented Interfaces:

SinkFactory

Direct Known Subclasses:

RtfSinkFactory

public abstract class AbstractBinarySinkFactory
extends Object
implements SinkFactory

An abstract SinkFactory for binary output.

Since:

1.1

Author:

Hervé Boutemy

Field Summary

Fields inherited from interface org.apache.maven.doxia.sink.SinkFactory

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractBinarySinkFactory()

Method Summary

Modifier and Type	Method	Description
Sink	createSink(File outputDir, String outputName)	Create a Sink into a file.
Sink	createSink(File outputDir, String outputName, String encoding)	Create a Sink into a file using a specified encoding.
Sink	createSink(OutputStream out)	Create a Sink into an OutputStream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.doxia.sink.SinkFactory

createSink

Constructor Detail

AbstractBinarySinkFactory

public AbstractBinarySinkFactory()

Method Detail

createSink

public Sink createSink(File outputDir,
                       String outputName)
                throws IOException

Create a Sink into a file.

Specified by:

createSink in interface SinkFactory

Parameters:

outputDir - the not-null output dir.

outputName - the not-null output name.

Returns:

a Sink instance with a file as output.

Throws:

IOException - if any.

createSink

public Sink createSink(File outputDir,
                       String outputName,
                       String encoding)
                throws IOException

Create a Sink into a file using a specified encoding.

Specified by:

createSink in interface SinkFactory

Parameters:

outputDir - the not-null output dir.

outputName - the not-null output name.

encoding - the output encoding.

Returns:

a Sink instance with a file as output and using specified encoding.

Throws:

IOException - if any.

See Also:

SinkFactory.createSink(File, String)

createSink

public Sink createSink(OutputStream out)
                throws IOException

Create a Sink into an OutputStream.

Specified by:

createSink in interface SinkFactory

Parameters:

out - not null OutputStream to write the result.

Returns:

a Sink instance.

Throws:

IOException - if any.