Package org.apache.maven.doxia.sink

Interface SinkFactory

public interface SinkFactory

A factory that creates a Sink object.

Since:

1.0-alpha-9

Version:

$Id: SinkFactory.java 736010 2009-01-20 13:06:57Z vsiveton $

Author:

Kenney Westerhof

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ROLE	The Plexus SinkFactory Role.

Method Summary

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

Field Detail

ROLE

static final java.lang.String ROLE

The Plexus SinkFactory Role.

Method Detail

createSink

Sink createSink(java.io.File outputDir,
                java.lang.String outputName)
         throws java.io.IOException

Create a Sink into a file.

Parameters:

outputDir - the not-null output dir.

outputName - the not-null output name.

Returns:

a Sink instance with a file as output.

Throws:

java.io.IOException - if any

createSink

Sink createSink(java.io.File outputDir,
                java.lang.String outputName,
                java.lang.String encoding)
         throws java.io.IOException

Create a Sink into a file using a specified encoding.

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:

java.io.IOException - if any

Since:

1.1

See Also:

createSink(File, String)

createSink

Sink createSink(java.io.OutputStream out)
         throws java.io.IOException

Create a Sink into an OutputStream.

Parameters:

out - not null OutputStream to write the result.

Returns:

a Sink instance.

Throws:

java.io.IOException - if any

Since:

1.1

createSink

Sink createSink(java.io.OutputStream out,
                java.lang.String encoding)
         throws java.io.IOException

Create a Sink into an OutputStream using a specified encoding.

Parameters:

out - not null OutputStream to write the result.

encoding - the output encoding.

Returns:

a Sink instance using specified encoding.

Throws:

java.io.IOException - if any

Since:

1.1