|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.maven.doxia.sink.AbstractTextSinkFactory
public abstract class AbstractTextSinkFactory
An abstract SinkFactory
for Text markup syntax. UTF-8
is used
when no encoding is specified.
Field Summary |
---|
Fields inherited from interface org.apache.maven.doxia.sink.SinkFactory |
---|
ROLE |
Constructor Summary | |
---|---|
AbstractTextSinkFactory()
|
Method Summary | |
---|---|
Sink |
createSink(File outputDir,
String outputName)
Create a Sink into a file. |
Sink |
createSink(File outputDir,
String outputName,
String encoding)
Create a Sink into a file using a specified encoding. |
Sink |
createSink(OutputStream out)
Create a Sink into an OutputStream. |
Sink |
createSink(OutputStream out,
String encoding)
Create a Sink into an OutputStream using a specified encoding. |
protected abstract Sink |
createSink(Writer writer,
String encoding)
Create a text Sink for a given encoding. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbstractTextSinkFactory()
Method Detail |
---|
protected abstract Sink createSink(Writer writer, String encoding)
writer
- The writer for the sink output, never null
.encoding
- The character encoding used by the writer.
public Sink createSink(File outputDir, String outputName) throws IOException
Sink
into a file.
createSink
in interface SinkFactory
outputDir
- the not-null output dir.outputName
- the not-null output name.
Sink
instance with a file as output.
IOException
- if anypublic Sink createSink(File outputDir, String outputName, String encoding) throws IOException
Sink
into a file using a specified encoding.
createSink
in interface SinkFactory
outputDir
- the not-null output dir.outputName
- the not-null output name.encoding
- the output encoding.
Sink
instance with a file as output and using specified encoding.
IOException
- if anySinkFactory.createSink(File, String)
public Sink createSink(OutputStream out) throws IOException
Sink
into an OutputStream.
createSink
in interface SinkFactory
out
- not null OutputStream to write the result.
Sink
instance.
IOException
- if anypublic Sink createSink(OutputStream out, String encoding) throws IOException
Sink
into an OutputStream using a specified encoding.
createSink
in interface SinkFactory
out
- not null OutputStream to write the result.encoding
- the output encoding.
Sink
instance using specified encoding.
IOException
- if any
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |