Package org.apache.maven.doxia.sink.impl
Class AbstractTextSinkFactory
java.lang.Object
org.apache.maven.doxia.sink.impl.AbstractTextSinkFactory
- All Implemented Interfaces:
SinkFactory
- Direct Known Subclasses:
AbstractXmlSinkFactory
,AptSinkFactory
,ConfluenceSinkFactory
,LatexSinkFactory
,TWikiSinkFactory
An abstract
SinkFactory
for Text markup syntax. UTF-8
is used
when no encoding is specified.- Since:
- 1.1
-
Field Summary
Fields inherited from interface org.apache.maven.doxia.sink.SinkFactory
ROLE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateSink
(File outputDir, String outputName) Create aSink
into a file.createSink
(File outputDir, String outputName, String encoding) Create aSink
into a file using a specified encoding.createSink
(OutputStream out) Create aSink
into an OutputStream.createSink
(OutputStream out, String encoding) Create aSink
into an OutputStream using a specified encoding.protected abstract Sink
createSink
(Writer writer, String encoding) Create a text Sink for a given encoding.
-
Constructor Details
-
AbstractTextSinkFactory
public AbstractTextSinkFactory()
-
-
Method Details
-
createSink
Create a text Sink for a given encoding.- Parameters:
writer
- The writer for the sink output, nevernull
.encoding
- The character encoding used by the writer.- Returns:
- a Sink for text output in the given encoding.
-
createSink
Create aSink
into a file.- Specified by:
createSink
in interfaceSinkFactory
- 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
Create aSink
into a file using a specified encoding.- Specified by:
createSink
in interfaceSinkFactory
- 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:
-
createSink
Create aSink
into an OutputStream.- Specified by:
createSink
in interfaceSinkFactory
- Parameters:
out
- not null OutputStream to write the result.- Returns:
- a
Sink
instance. - Throws:
IOException
- if any.
-
createSink
Create aSink
into an OutputStream using a specified encoding.- Specified by:
createSink
in interfaceSinkFactory
- Parameters:
out
- not null OutputStream to write the result.encoding
- the output encoding.- Returns:
- a
Sink
instance using specified encoding. - Throws:
IOException
- if any.
-