Class AbstractTextSinkFactory

  • All Implemented Interfaces:
    org.apache.maven.doxia.sink.SinkFactory
    Direct Known Subclasses:
    AbstractXmlSinkFactory

    public abstract class AbstractTextSinkFactory
    extends java.lang.Object
    implements org.apache.maven.doxia.sink.SinkFactory
    An abstract SinkFactory for Text markup syntax. UTF-8 is used when no encoding is specified.
    Since:
    1.1
    Author:
    Hervé Boutemy, Benjamin Bentmann
    • Field Summary

      • Fields inherited from interface org.apache.maven.doxia.sink.SinkFactory

        ROLE
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      org.apache.maven.doxia.sink.Sink createSink​(java.io.File outputDir, java.lang.String outputName)
      org.apache.maven.doxia.sink.Sink createSink​(java.io.File outputDir, java.lang.String outputName, java.lang.String encoding)
      org.apache.maven.doxia.sink.Sink createSink​(java.io.OutputStream out)
      org.apache.maven.doxia.sink.Sink createSink​(java.io.OutputStream out, java.lang.String encoding)
      protected abstract org.apache.maven.doxia.sink.Sink createSink​(java.io.Writer writer, java.lang.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 org.apache.maven.doxia.sink.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, never null.
        encoding - The character encoding used by the writer.
        Returns:
        a Sink for text output in the given encoding.
      • createSink

        public org.apache.maven.doxia.sink.Sink createSink​(java.io.File outputDir,
                                                           java.lang.String outputName)
                                                    throws java.io.IOException
        Specified by:
        createSink in interface org.apache.maven.doxia.sink.SinkFactory
        Throws:
        java.io.IOException
      • createSink

        public org.apache.maven.doxia.sink.Sink createSink​(java.io.File outputDir,
                                                           java.lang.String outputName,
                                                           java.lang.String encoding)
                                                    throws java.io.IOException
        Specified by:
        createSink in interface org.apache.maven.doxia.sink.SinkFactory
        Throws:
        java.io.IOException
      • createSink

        public org.apache.maven.doxia.sink.Sink createSink​(java.io.OutputStream out)
                                                    throws java.io.IOException
        Specified by:
        createSink in interface org.apache.maven.doxia.sink.SinkFactory
        Throws:
        java.io.IOException
      • createSink

        public org.apache.maven.doxia.sink.Sink createSink​(java.io.OutputStream out,
                                                           java.lang.String encoding)
                                                    throws java.io.IOException
        Specified by:
        createSink in interface org.apache.maven.doxia.sink.SinkFactory
        Throws:
        java.io.IOException