org.jodconverter.core

Interface DocumentConverter

All Known Implementing Classes:

AbstractConverter

public interface DocumentConverter

A DocumentConverter is responsible to execute the conversion of documents using an office manager.

Method Summary

Modifier and Type	Method and Description
@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.

Method Detail

convert

@NonNull ConversionJobWithOptionalSourceFormatUnspecified convert(@NonNull File source)

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

Parameters:

source - The conversion input as a file.

Returns:

The current conversion specification.

convert

@NonNull ConversionJobWithOptionalSourceFormatUnspecified convert(@NonNull InputStream source)

Converts a source stream input stream.

Parameters:

source - The conversion input as an input stream.

Returns:

The current conversion specification.

convert

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

Converts a source stream input stream.

Parameters:

source - The conversion input as an input stream.

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

Returns:

The current conversion specification.

getFormatRegistry

@NonNull DocumentFormatRegistry getFormatRegistry()

Gets all the DocumentFormat supported by the converter.

Returns:

A DocumentFormatRegistry containing the supported formats.