org.jodconverter.core.job

Class AbstractConversionJobWithSourceFormatUnspecified

java.lang.Object

org.jodconverter.core.job.AbstractConversionJobWithSourceFormatUnspecified

All Implemented Interfaces:

ConversionJobWithOptionalSourceFormatUnspecified, ConversionJobWithSourceSpecified

public abstract class AbstractConversionJobWithSourceFormatUnspecified
extends Object
implements ConversionJobWithOptionalSourceFormatUnspecified

Base class for all conversion job implementations with source format that is not yet applied to the converter.

See Also:

ConversionJobWithOptionalSourceFormatUnspecified

Field Summary

Fields

Modifier and Type	Field and Description
protected DocumentFormatRegistry	formatRegistry
protected OfficeManager	officeManager
protected AbstractSourceDocumentSpecs	source

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConversionJobWithSourceFormatUnspecified(@NonNull AbstractSourceDocumentSpecs source, @NonNull OfficeManager officeManager, @NonNull DocumentFormatRegistry formatRegistry)

Method Summary

Modifier and Type	Method and Description
@NonNull AbstractConversionJobWithSourceFormatUnspecified	as(@NonNull DocumentFormat format) Defines the source document format for the given input document.
protected abstract @NonNull AbstractConversionJob	to(@NonNull AbstractTargetDocumentSpecs target) Configures the current conversion to write the result using the specified specifications.
@NonNull AbstractConversionJob	to(@NonNull File target) Configures the current conversion to write the result to the specified target.
@NonNull AbstractConversionJob	to(@NonNull OutputStream target) Configures the current conversion to write the result to the specified OutputStream.
@NonNull AbstractConversionJob	to(@NonNull OutputStream target, boolean closeStream) Configures the current conversion to write the result to the specified OutputStream.

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

officeManager

protected final OfficeManager officeManager

formatRegistry

protected final DocumentFormatRegistry formatRegistry

Constructor Detail

AbstractConversionJobWithSourceFormatUnspecified

protected AbstractConversionJobWithSourceFormatUnspecified(@NonNull AbstractSourceDocumentSpecs source,
                                                           @NonNull OfficeManager officeManager,
                                                           @NonNull DocumentFormatRegistry formatRegistry)

Method Detail

as

public @NonNull AbstractConversionJobWithSourceFormatUnspecified as(@NonNull DocumentFormat format)

Description copied from interface: ConversionJobWithOptionalSourceFormatUnspecified

Defines the source document format for the given input document.

Specified by:

as in interface ConversionJobWithOptionalSourceFormatUnspecified

Parameters:

format - The document format of the source document.

Returns:

The current conversion specification.

to

public @NonNull AbstractConversionJob to(@NonNull File target)

Description copied from interface: ConversionJobWithSourceSpecified

Configures the current conversion to write the result to the specified target.

Specified by:

to in interface ConversionJobWithSourceSpecified

Parameters:

target - The file to which the result of the conversion will be written. Existing files will be overwritten. If the file is locked by the JVM or any other application or is not writable, an exception will be thrown.

Returns:

The current conversion specification.

to

public @NonNull AbstractConversionJob to(@NonNull OutputStream target)

Description copied from interface: ConversionJobWithSourceSpecified

Configures the current conversion to write the result to the specified OutputStream. The stream will be closed after the conversion is written.

Specified by:

to in interface ConversionJobWithSourceSpecified

Parameters:

target - The output stream to which the conversion result is written to.

Returns:

The current conversion specification.

to

public @NonNull AbstractConversionJob to(@NonNull OutputStream target,
                                         boolean closeStream)

Description copied from interface: ConversionJobWithSourceSpecified

Configures the current conversion to write the result to the specified OutputStream. The stream will be closed after the conversion is written.

Specified by:

to in interface ConversionJobWithSourceSpecified

Parameters:

target - The output stream to which the conversion result is written to.

closeStream - Determines whether the output stream is closed after writing the result.

Returns:

The current conversion specification.

to

protected abstract @NonNull AbstractConversionJob to(@NonNull AbstractTargetDocumentSpecs target)

Configures the current conversion to write the result using the specified specifications.

Parameters:

target - The target specifications to use for the conversion.

Returns:

The current conversion specification.