com.documents4j.conversion

Class DefaultConversionManager

java.lang.Object

com.documents4j.conversion.DefaultConversionManager

All Implemented Interfaces:

IConversionManager

public class DefaultConversionManager
extends Object
implements IConversionManager

A default implementation of an IConversionManager.

Constructor Summary

Constructors

Constructor and Description
DefaultConversionManager(File baseFolder, long processTimeout, TimeUnit timeUnit, Map<Class<? extends IExternalConverter>,Boolean> externalConverterRegistration)

Method Summary

Modifier and Type	Method and Description
Map<DocumentType,Set<DocumentType>>	getSupportedConversions() Returns a mapping of all conversions that are supported by the backing conversion engine.
boolean	isOperational() Checks if all converter back-ends that are represented by this conversion manager are operational.
void	shutDown() Shuts down all converter back-ends that are represented by this conversion manager.
Future<Boolean>	startConversion(File source, DocumentType sourceFormat, File target, DocumentType targetFormat) Schedules a conversion from an input file to be converted into the target format.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultConversionManager

public DefaultConversionManager(File baseFolder,
                                long processTimeout,
                                TimeUnit timeUnit,
                                Map<Class<? extends IExternalConverter>,Boolean> externalConverterRegistration)

Method Detail

startConversion

public Future<Boolean> startConversion(File source,
                                       DocumentType sourceFormat,
                                       File target,
                                       DocumentType targetFormat)

Description copied from interface: IConversionManager

Schedules a conversion from an input file to be converted into the target format.

Specified by:

startConversion in interface IConversionManager

Parameters:

source - The source file which is to be converted.

sourceFormat - The file format of the source file.

target - The target file to which the converted file should be saved.

targetFormat - The file format of the target file.

Returns:

A future that represents a pending conversion where the enclosed boolean represents the conversion's success.

getSupportedConversions

public Map<DocumentType,Set<DocumentType>> getSupportedConversions()

Description copied from interface: IConversionManager

Returns a mapping of all conversions that are supported by the backing conversion engine.

Specified by:

getSupportedConversions in interface IConversionManager

Returns:

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.

isOperational

public boolean isOperational()

Description copied from interface: IConversionManager

Checks if all converter back-ends that are represented by this conversion manager are operational.

Specified by:

isOperational in interface IConversionManager

Returns:

true if the all represented converters are operational.

shutDown

public void shutDown()

Description copied from interface: IConversionManager

Shuts down all converter back-ends that are represented by this conversion manager.

Specified by:

shutDown in interface IConversionManager