com.documents4j.conversion

Interface IExternalConverter

public interface IExternalConverter

Represents a converter back-end which is capable of applying a document conversion.

Method Summary

Modifier and Type	Method and Description
boolean	isOperational() Checks if this converter back-end is operational.
void	shutDown() Shuts down this converter.
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.

isOperational

boolean isOperational()

Checks if this converter back-end is operational.

Returns:

true if this converter is operational.

shutDown

void shutDown()

Shuts down this converter.