Package ch.tocco.nice2.conversion.api

Interface ConverterEngine<T extends ConverterConfig>

All Known Implementing Classes:
Plain2HtmlConverter, WkHtmlToPdfConverter
public interface ConverterEngine<T extends ConverterConfig>
Interface for an engine to convert a specific InputStream format to a specific OutputStream format

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    convert(T converterConfig)
    Convert the InputStream to the desired format and write to the provided OutputStream.
    String
    getName()
    Returns the name of the converter engine
    T
    getNewConverterConfig(InputStream source, OutputStream target)
    get a new converter config object for this engine

  • Method Details

    • getName

      String getName()
      Returns the name of the converter engine

    • convert

      void convert(T converterConfig) throws ConversionException
      Convert the InputStream to the desired format and write to the provided OutputStream.
      Parameters:
      converterConfig - config object obtained from getNewConverterConfig(InputStream, OutputStream)
      Throws:
      ConversionException - -

    • getNewConverterConfig

      T getNewConverterConfig(InputStream source, OutputStream target)
      get a new converter config object for this engine
      Parameters:
      source - the source to be converted
      target - the target to write to
      Returns:
      a converter config object