com.documents4j.api

Interface IConversionJob

All Known Subinterfaces:

IConversionJobWithPriorityUnspecified

public interface IConversionJob

A fully specified conversion that is not yet applied to the converter.

Method Summary

Modifier and Type	Method and Description
boolean	execute() Executes a conversion and blocks until the conversion terminates.
Future<Boolean>	schedule() Schedules the specified conversion to be executed in the background.

Method Detail

schedule

Future<Boolean> schedule()

Schedules the specified conversion to be executed in the background.

Returns:

A future indicating true if the conversion was successful, throwing an exception if the conversion failed with an error or indicating false if the conversion was aborted.

execute

boolean execute()

Executes a conversion and blocks until the conversion terminates. This is not a synonym for calling Future.get() on schedule(): Thrown exceptions will additionally be unwrapped from any ExecutionException.

Note: In the current version, all callback methods will be executed from another thread than the current thread. This behavior might change in a future version.

Returns:

true if the conversion was successful, or false if the conversion was aborted.

Throws:

ConverterException - If the conversion failed.