org.apache.maven.doxia.sink
Class AbstractTextSinkFactory

java.lang.Object
  extended by org.apache.maven.doxia.sink.AbstractTextSinkFactory
All Implemented Interfaces:
SinkFactory
Direct Known Subclasses:
AbstractXmlSinkFactory

public abstract class AbstractTextSinkFactory
extends Object
implements SinkFactory

An abstract SinkFactory for Text markup syntax. UTF-8 is used when no encoding is specified.

Since:
1.1
Version:
$Id: AbstractTextSinkFactory.java 746978 2009-02-23 12:20:33Z vsiveton $
Author:
Hervé Boutemy, Benjamin Bentmann

Field Summary
 
Fields inherited from interface org.apache.maven.doxia.sink.SinkFactory
ROLE
 
Constructor Summary
AbstractTextSinkFactory()
           
 
Method Summary
 Sink createSink(File outputDir, String outputName)
          
 Sink createSink(File outputDir, String outputName, String encoding)
          
 Sink createSink(OutputStream out)
          
 Sink createSink(OutputStream out, String 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

AbstractTextSinkFactory

public AbstractTextSinkFactory()
Method Detail

createSink

protected abstract Sink createSink(Writer writer,
                                   String encoding)
Create a text Sink for a given encoding.

Parameters:
writer - The writer for the sink output, never null.
encoding - The character encoding used by the writer.
Returns:
a Sink for text output in the given encoding.

createSink

public Sink createSink(File outputDir,
                       String outputName)
                throws IOException

Specified by:
createSink in interface SinkFactory
Throws:
IOException

createSink

public Sink createSink(File outputDir,
                       String outputName,
                       String encoding)
                throws IOException

Specified by:
createSink in interface SinkFactory
Throws:
IOException

createSink

public Sink createSink(OutputStream out)
                throws IOException

Specified by:
createSink in interface SinkFactory
Throws:
IOException

createSink

public Sink createSink(OutputStream out,
                       String encoding)
                throws IOException

Specified by:
createSink in interface SinkFactory
Throws:
IOException


Copyright © 2005-2012 The Apache Software Foundation. All Rights Reserved.