org.jodconverter.core.job

Class AbstractConversionJob

java.lang.Object

org.jodconverter.core.job.AbstractConversionJob

All Implemented Interfaces:

ConversionJob, ConversionJobWithOptionalTargetFormatUnspecified, ConversionJobWithRequiredTargetFormatUnspecified

public abstract class AbstractConversionJob
extends Object
implements ConversionJobWithOptionalTargetFormatUnspecified

Base class for all conversion job implementations.

See Also:

ConversionJob

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractSourceDocumentSpecs	source
protected AbstractTargetDocumentSpecs	target

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConversionJob(@NonNull AbstractSourceDocumentSpecs source, @NonNull AbstractTargetDocumentSpecs target)

Method Summary

Modifier and Type	Method and Description
@NonNull AbstractConversionJob	as(@NonNull DocumentFormat format) Defines the target document format for the given input document.
protected abstract void	doExecute() Executes the conversion and blocks until the conversion terminates.
void	execute() Executes a conversion and blocks until the conversion terminates.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

source

protected final AbstractSourceDocumentSpecs source

target

protected final AbstractTargetDocumentSpecs target

Constructor Detail

AbstractConversionJob

protected AbstractConversionJob(@NonNull AbstractSourceDocumentSpecs source,
                                @NonNull AbstractTargetDocumentSpecs target)

Method Detail

as

public @NonNull AbstractConversionJob as(@NonNull DocumentFormat format)

Description copied from interface: ConversionJobWithRequiredTargetFormatUnspecified

Defines the target document format for the given input document.

Specified by:

as in interface ConversionJobWithRequiredTargetFormatUnspecified

Parameters:

format - The document format of the target document.

Returns:

The current conversion specification.

execute

public final void execute()
                   throws OfficeException

Description copied from interface: ConversionJob

Executes a conversion and blocks until the conversion terminates.

Specified by:

execute in interface ConversionJob

Throws:

OfficeException - If the conversion failed.

doExecute

protected abstract void doExecute()
                           throws OfficeException

Executes the conversion and blocks until the conversion terminates. Both source and target document formats are known and valid at this point.

Throws:

OfficeException - If the conversion failed.