org.jodconverter.local

Class LocalConverter

java.lang.Object

org.jodconverter.core.job.AbstractConverter

org.jodconverter.local.LocalConverter

All Implemented Interfaces:

org.jodconverter.core.DocumentConverter

public final class LocalConverter
extends org.jodconverter.core.job.AbstractConverter

Default implementation of a document converter. This implementation will use a provided office manager to perform document conversion. The provided office manager must be started in order to be used by this converter.

See Also:

DocumentConverter, OfficeManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocalConverter.Builder A builder for constructing a LocalConverter.

Nested classes/interfaces inherited from class org.jodconverter.core.job.AbstractConverter

org.jodconverter.core.job.AbstractConverter.AbstractConverterBuilder<B extends org.jodconverter.core.job.AbstractConverter.AbstractConverterBuilder<B>>

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_APPLY_DEFAULT_LOAD_PROPS The default behavior regarding the usage of the default load properties.
static LoadDocumentMode	DEFAULT_LOAD_DOCUMENT_MODE The default behavior regarding the loading of a document.
static Map<String,Object>	DEFAULT_LOAD_PROPERTIES The properties which are applied by default when loading a document if not manually overridden.
static boolean	DEFAULT_USE_UNSAFE_QUIET_UPDATE The default behavior regarding the default load property UpdateDocMode, which has been changed from UpdateDocMode.QUIET_UPDATE to UpdateDocMode.NO_UPDATE for security reason.

Fields inherited from class org.jodconverter.core.job.AbstractConverter

formatRegistry, officeManager

Method Summary

Modifier and Type	Method and Description
static @NonNull LocalConverter.Builder	builder() Creates a new builder instance.
protected @NonNull org.jodconverter.core.job.AbstractConversionJobWithSourceFormatUnspecified	convert(@NonNull org.jodconverter.core.job.AbstractSourceDocumentSpecs source)
static @NonNull LocalConverter	make() Creates a new LocalConverter with default configuration.
static @NonNull LocalConverter	make(@NonNull org.jodconverter.core.office.OfficeManager officeManager) Creates a new LocalConverter using the specified OfficeManager with default configuration.

Methods inherited from class org.jodconverter.core.job.AbstractConverter

convert, convert, convert, getFormatRegistry

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_APPLY_DEFAULT_LOAD_PROPS

public static final boolean DEFAULT_APPLY_DEFAULT_LOAD_PROPS

The default behavior regarding the usage of the default load properties.

See Also:

Constant Field Values

DEFAULT_USE_UNSAFE_QUIET_UPDATE

public static final boolean DEFAULT_USE_UNSAFE_QUIET_UPDATE

The default behavior regarding the default load property UpdateDocMode, which has been changed from UpdateDocMode.QUIET_UPDATE to UpdateDocMode.NO_UPDATE for security reason.

See Also:

Constant Field Values

DEFAULT_LOAD_DOCUMENT_MODE

public static final LoadDocumentMode DEFAULT_LOAD_DOCUMENT_MODE

The default behavior regarding the loading of a document.

DEFAULT_LOAD_PROPERTIES

public static final Map<String,Object> DEFAULT_LOAD_PROPERTIES

The properties which are applied by default when loading a document if not manually overridden.

Method Detail

builder

public static @NonNull LocalConverter.Builder builder()

Creates a new builder instance.

Returns:

A new builder instance.

make

public static @NonNull LocalConverter make()

Creates a new LocalConverter with default configuration. The OfficeManager that will be used is the one holden by the InstalledOfficeManagerHolder class, if any.

Returns:

A LocalConverter with default configuration.

make

public static @NonNull LocalConverter make(@NonNull org.jodconverter.core.office.OfficeManager officeManager)

Creates a new LocalConverter using the specified OfficeManager with default configuration.

Parameters:

officeManager - The OfficeManager the converter will use to convert document.

Returns:

A LocalConverter with default configuration.

convert

protected @NonNull org.jodconverter.core.job.AbstractConversionJobWithSourceFormatUnspecified convert(@NonNull org.jodconverter.core.job.AbstractSourceDocumentSpecs source)

Specified by:

convert in class org.jodconverter.core.job.AbstractConverter