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
,ITextSinkFactory
,LatexSinkFactory
,TWikiSinkFactory
public abstract class AbstractTextSinkFactory extends java.lang.Object implements SinkFactory
An abstractSinkFactory
for Text markup syntax.UTF-8
is used when no encoding is specified.- Since:
- 1.1
- Version:
- $Id: AbstractTextSinkFactory.java 1726411 2016-01-23 16:34:09Z hboutemy $
- Author:
- Hervé Boutemy, Benjamin Bentmann
-
-
Field Summary
-
Fields inherited from interface org.apache.maven.doxia.sink.SinkFactory
ROLE
-
-
Constructor Summary
Constructors Constructor Description AbstractTextSinkFactory()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete 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.protected abstract Sink
createSink(java.io.Writer writer, java.lang.String encoding)
Create a text Sink for a given encoding.
-
-
-
Method Detail
-
createSink
protected abstract Sink createSink(java.io.Writer writer, java.lang.String encoding)
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
public Sink createSink(java.io.File outputDir, java.lang.String outputName) throws java.io.IOException
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:
java.io.IOException
- if any
-
createSink
public 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.- 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:
java.io.IOException
- if any- See Also:
SinkFactory.createSink(File, String)
-
createSink
public Sink createSink(java.io.OutputStream out) throws java.io.IOException
Create aSink
into an OutputStream.- Specified by:
createSink
in interfaceSinkFactory
- Parameters:
out
- not null OutputStream to write the result.- Returns:
- a
Sink
instance. - Throws:
java.io.IOException
- if any
-
createSink
public Sink createSink(java.io.OutputStream out, java.lang.String encoding) throws java.io.IOException
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:
java.io.IOException
- if any
-
-