org.daisy.dotify.api.engine.FormatterEngine Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dotify.library Show documentation

Dotify Library

There is a newer version: 1.0.7

package org.daisy.dotify.api.engine;

import java.io.InputStream;
import java.io.OutputStream;

/**
 * Provides a formatter engine. The formatter engine is the outer layer
 * of the formatter, requiring only an input stream and an output stream.
 *
 * @author Joel Håkansson
 */
public interface FormatterEngine {

    /**
     * Converts the OBFL in the input stream and writes the result to the output stream.
     *
     * @param input  the OBFL input
     * @param output the output stream
     * @throws LayoutEngineException if the conversion fails
     */
    public void convert(InputStream input, OutputStream output) throws LayoutEngineException;
}