org.jodconverter.core.job

Class AbstractConverter

java.lang.Object

org.jodconverter.core.job.AbstractConverter

All Implemented Interfaces:

DocumentConverter

public abstract class AbstractConverter
extends Object
implements DocumentConverter

Base class for all document converter implementations.

See Also:

DocumentConverter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractConverter.AbstractConverterBuilder<B extends AbstractConverter.AbstractConverterBuilder<B>> A builder for constructing an AbstractConverter.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConverter(@NonNull OfficeManager officeManager, @NonNull DocumentFormatRegistry formatRegistry)

Method Summary

Modifier and Type	Method and Description
protected abstract @NonNull AbstractConversionJobWithSourceFormatUnspecified	convert(@NonNull AbstractSourceDocumentSpecs source) Converts a source document using the given specifications.
@NonNull ConversionJobWithOptionalSourceFormatUnspecified	convert(@NonNull File source) Converts a source file that is stored on the local file system.
@NonNull ConversionJobWithOptionalSourceFormatUnspecified	convert(@NonNull InputStream source) Converts a source stream input stream.
@NonNull ConversionJobWithOptionalSourceFormatUnspecified	convert(@NonNull InputStream source, boolean closeStream) Converts a source stream input stream.
@NonNull DocumentFormatRegistry	getFormatRegistry() Gets all the DocumentFormat supported by the converter.

Methods inherited from class java.lang.Object

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

Field Detail

officeManager

protected final OfficeManager officeManager

formatRegistry

protected final DocumentFormatRegistry formatRegistry

Constructor Detail

AbstractConverter

protected AbstractConverter(@NonNull OfficeManager officeManager,
                            @NonNull DocumentFormatRegistry formatRegistry)

Method Detail

convert

public @NonNull ConversionJobWithOptionalSourceFormatUnspecified convert(@NonNull File source)

Description copied from interface: DocumentConverter

Converts a source file that is stored on the local file system.

Specified by:

convert in interface DocumentConverter

Parameters:

source - The conversion input as a file.

Returns:

The current conversion specification.

convert

public @NonNull ConversionJobWithOptionalSourceFormatUnspecified convert(@NonNull InputStream source)

Description copied from interface: DocumentConverter

Converts a source stream input stream.

Specified by:

convert in interface DocumentConverter

Parameters:

source - The conversion input as an input stream.

Returns:

The current conversion specification.

convert

public @NonNull ConversionJobWithOptionalSourceFormatUnspecified convert(@NonNull InputStream source,
                                                                         boolean closeStream)

Description copied from interface: DocumentConverter

Converts a source stream input stream.

Specified by:

convert in interface DocumentConverter

Parameters:

source - The conversion input as an input stream.

closeStream - Whether the InputStream is closed after the conversion terminates.

Returns:

The current conversion specification.

convert

protected abstract @NonNull AbstractConversionJobWithSourceFormatUnspecified convert(@NonNull AbstractSourceDocumentSpecs source)

Converts a source document using the given specifications.

Parameters:

source - The conversion input as a document specifications.

Returns:

The current conversion specification.

getFormatRegistry

public @NonNull DocumentFormatRegistry getFormatRegistry()

Description copied from interface: DocumentConverter

Gets all the DocumentFormat supported by the converter.

Specified by:

getFormatRegistry in interface DocumentConverter

Returns:

A DocumentFormatRegistry containing the supported formats.