Package com.documents4j.api
Interface IConversionJob
-
- All Known Subinterfaces:
IConversionJobWithPriorityUnspecified
public interface IConversionJobA fully specified conversion that is not yet applied to the converter.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleanexecute()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
trueif the conversion was successful, throwing an exception if the conversion failed with an error or indicatingfalseif the conversion was aborted.
-
execute
boolean execute()
Executes a conversion and blocks until the conversion terminates. This is not a synonym for callingFuture.get()onschedule(): Thrown exceptions will additionally be unwrapped from anyExecutionException.
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:
trueif the conversion was successful, orfalseif the conversion was aborted.- Throws:
ConverterException- If the conversion failed.
-
-