com.documents4j.conversion

Interface IConversionManager

All Known Implementing Classes:

DefaultConversionManager

public interface IConversionManager

A manager for conversions which offers a common interface for querying different converter back-ends.

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.

Method Detail

startConversion

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.

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

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

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

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

boolean isOperational()

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

Returns:

true if the all represented converters are operational.

shutDown

void shutDown()

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