org.jodconverter.job

Interface TargetDocumentSpecs

All Known Implementing Classes:

AbstractTargetDocumentSpecs

public interface TargetDocumentSpecs

An interface that provides the behavior to apply when a target file is no longer required by a conversion process.

Method Summary

Modifier and Type	Method and Description
File	getFile() Gets the file where is located the document.
DocumentFormat	getFormat() Gets the DocumentFormat specification for the document.
void	onComplete(File file) Called if the conversion was completed successfully.
void	onFailure(File file, Exception exception) Called if the conversion finished with an exception.

Method Detail

onComplete

void onComplete(File file)

Called if the conversion was completed successfully.

Parameters:

file - The file to which the conversion result was written.

onFailure

void onFailure(File file,
               Exception exception)

Called if the conversion finished with an exception.

Parameters:

file - The file to which the conversion result was supposed to be written.

exception - An exception representing the reason for the failed conversion.

getFile

File getFile()

Gets the file where is located the document.

Returns:

A file instance.

getFormat

DocumentFormat getFormat()

Gets the DocumentFormat specification for the document.

Returns:

The document format.