org.asciidoctor.converter.AbstractConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of asciidoctorj-api Show documentation

API for AsciidoctorJ

There is a newer version: 3.0.0

package org.asciidoctor.converter;

import org.asciidoctor.log.LogHandler;
import org.asciidoctor.log.LogRecord;
import org.asciidoctor.log.Logging;

import java.util.Map;

/**
 * An abstract base class for Java based converters.
 * Instead of directly implementing {@link Converter} Java converters should extend this class.
 * For converters producing string output consider extending the {@link StringConverter} class.
 * @param  The type of result this converter produces, e.g. {@link String}.
 */
public abstract class AbstractConverter implements Converter, OutputFormatWriter, Logging, LogHandler {

    private String backend;

    private Map options;

    private String outfilesuffix = null;

    private LogHandler logHandler;

    public AbstractConverter(String backend, Map opts) {
        this.backend = backend;
        this.options = opts;
    }

    @Override
    public Map getOptions() {
        return options;
    }

    public String getBackend() {
        return backend;
    }

    @Override
    public String getOutfileSuffix() {
        return outfilesuffix;
    }

    @Override
    public void setOutfileSuffix(String outfilesuffix) {
        this.outfilesuffix = outfilesuffix;
    }

    @Override
    public void log(LogRecord logRecord) {
        if (logHandler != null) {
            logHandler.log(logRecord);
        }
    }

    @Override
    public void setLogHandler(LogHandler logHandler) {
        this.logHandler = logHandler;
    }
}