com.documents4j.conversion.IConversionManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of documents4j-transformer Show documentation

There is a newer version: 1.1.12

Show newest version

package com.documents4j.conversion;

import com.documents4j.api.DocumentType;

import java.io.File;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.Future;

/**
 * A manager for conversions which offers a common interface for querying different converter back-ends.
 */
public interface IConversionManager {

    /**
     * Schedules a conversion from an input file to be converted into the target format.
     *
     * @param source       The source file which is to be converted.
     * @param sourceFormat The file format of the source file.
     * @param target       The target file to which the converted file should be saved.
     * @param targetFormat The file format of the target file.
     * @return A future that represents a pending conversion where the enclosed {@code boolean} represents the
     * conversion's success.
     */
    Future startConversion(File source, DocumentType sourceFormat, File target, DocumentType targetFormat);

    /**
     * Returns a mapping of all conversions that are supported by the backing conversion engine.
     *
     * @return A map of all possible conversions with the key describing the input types and the set
     * describing the formats that these input types can be converted into.
     */
    Map> getSupportedConversions();

    /**
     * Checks if all converter back-ends that are represented by this conversion manager are operational.
     *
     * @return {@code true} if the all represented converters are operational.
     */
    boolean isOperational();

    /**
     * Shuts down all converter back-ends that are represented by this conversion manager.
     */
    void shutDown();
}