Package org.apache.maven.doxia.sink
Interface SinkFactory
-
- All Known Implementing Classes:
AbstractBinarySinkFactory
,AbstractTextSinkFactory
,AbstractXmlSinkFactory
,AptSinkFactory
,ConfluenceSinkFactory
,DocbookSinkFactory
,FoSinkFactory
,ITextSinkFactory
,LatexSinkFactory
,RtfSinkFactory
,TWikiSinkFactory
,XdocSinkFactory
,XhtmlSinkFactory
public interface SinkFactory
A factory that creates aSink
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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Sink
createSink(java.io.File outputDir, java.lang.String outputName)
Create aSink
into a file.Sink
createSink(java.io.File outputDir, java.lang.String outputName, java.lang.String encoding)
Create aSink
into a file using a specified encoding.Sink
createSink(java.io.OutputStream out)
Create aSink
into an OutputStream.Sink
createSink(java.io.OutputStream out, java.lang.String encoding)
Create aSink
into an OutputStream using a specified encoding.
-
-
-
Method Detail
-
createSink
Sink createSink(java.io.File outputDir, java.lang.String outputName) throws java.io.IOException
Create aSink
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 aSink
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 aSink
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 aSink
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
-
-