Package org.apache.maven.doxia.sink.impl

Class AbstractBinarySinkFactory

  • All Implemented Interfaces:
    SinkFactory
    Direct Known Subclasses:
    RtfSinkFactory
    public abstract class AbstractBinarySinkFactory
extends java.lang.Object
implements SinkFactory
    An abstract SinkFactory for binary output.
    Since:
    1.1
    Version:
    $Id: AbstractBinarySinkFactory.java 1726411 2016-01-23 16:34:09Z hboutemy $
    Author:
    Hervé Boutemy

    • Field Summary

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Sink createSink​(java.io.File outputDir, java.lang.String outputName)
      Create a Sink into a file.
      Sink createSink​(java.io.File outputDir, java.lang.String outputName, java.lang.String encoding)
      Create a Sink into a file using a specified encoding.
      Sink createSink​(java.io.OutputStream out)
      Create a Sink into an OutputStream.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AbstractBinarySinkFactory

        public AbstractBinarySinkFactory()

    • Method Detail

      • createSink

        public Sink createSink​(java.io.File outputDir,
                       java.lang.String outputName)
                throws java.io.IOException
        Create a Sink into a file.
        Specified by:
        createSink in interface SinkFactory
        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 a Sink into a file using a specified encoding.
        Specified by:
        createSink in interface SinkFactory
        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 a Sink into an OutputStream.
        Specified by:
        createSink in interface SinkFactory
        Parameters:
        out - not null OutputStream to write the result.
        Returns:
        a Sink instance.
        Throws:
        java.io.IOException - if any