Package org.apache.maven.doxia.sink
Interface SinkFactory
public interface SinkFactory
A factory that creates a
Sink object.- Since:
- 1.0-alpha-9
- Author:
- Kenney Westerhof
-
Method Summary
Modifier and TypeMethodDescriptioncreateSink(File outputDir, String outputName) Create aSinkinto a file.createSink(File outputDir, String outputName, String encoding) Create aSinkinto a file using a specified encoding.createSink(OutputStream out) Create aSinkinto an OutputStream.createSink(OutputStream out, String encoding) Create aSinkinto an OutputStream using a specified encoding.
-
Method Details
-
createSink
Create aSinkinto a file.- Parameters:
outputDir- the not-null output dir.outputName- the not-null output name.- Returns:
- a
Sinkinstance with a file as output. - Throws:
IOException- if any.
-
createSink
Create aSinkinto 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
Sinkinstance with a file as output and using specified encoding. - Throws:
IOException- if any.- Since:
- 1.1
- See Also:
-
createSink
Create aSinkinto an OutputStream.- Parameters:
out- not null OutputStream to write the result.- Returns:
- a
Sinkinstance. - Throws:
IOException- if any.- Since:
- 1.1
-
createSink
Create aSinkinto an OutputStream using a specified encoding.- Parameters:
out- not null OutputStream to write the result.encoding- the output encoding.- Returns:
- a
Sinkinstance using specified encoding. - Throws:
IOException- if any.- Since:
- 1.1
-