org.jodconverter.local

Class LocalConverter.Builder

java.lang.Object

org.jodconverter.core.job.AbstractConverter.AbstractConverterBuilder<LocalConverter.Builder>

org.jodconverter.local.LocalConverter.Builder

Enclosing class:

LocalConverter

public static final class LocalConverter.Builder
extends org.jodconverter.core.job.AbstractConverter.AbstractConverterBuilder<LocalConverter.Builder>

A builder for constructing a LocalConverter.

See Also:

LocalConverter

Field Summary

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

formatRegistry, officeManager

Method Summary

Modifier and Type	Method and Description
@NonNull LocalConverter.Builder	applyDefaultLoadProperties(boolean applyDefaultLoadProperties) Specifies this converter will apply the default load properties when loading a source document.
@NonNull LocalConverter	build()
@NonNull LocalConverter.Builder	filterChain(Filter... filters) Specifies the filters to apply when converting a document.
@NonNull LocalConverter.Builder	filterChain(@NonNull FilterChain filterChain) Specifies the whole filter chain to apply when converting a document.
@NonNull LocalConverter.Builder	loadDocumentMode(@Nullable LoadDocumentMode loadDocumentMode) Specifies how a document is loaded/stored when converting a document, whether it is loaded assuming the office process has access to the file on disk or not.
@NonNull LocalConverter.Builder	loadProperties(@NonNull Map<String,Object> loadProperties) Specifies properties, for this converter, that will be applied when a document is loaded during a conversion task, regardless of the input format of the document.
@NonNull LocalConverter.Builder	loadProperty(@NonNull String name, @NonNull Object value) Specifies a property, for this converter, that will be applied when a document is loaded during a conversion task, regardless of the input format of the document.
@NonNull LocalConverter.Builder	storeProperties(@NonNull Map<String,Object> storeProperties) Specifies the properties that will be applied when a document is stored during the conversion task, regardless of the output format of the document.
@NonNull LocalConverter.Builder	storeProperty(@NonNull String name, @NonNull Object value) Specifies a property, for this converter, that will be applied when a document is stored during a conversion task, regardless of the output format of the document.
@NonNull LocalConverter.Builder	useUnsafeQuietUpdate(boolean useUnsafeQuietUpdate) Specifies whether this converter will use the unsafe UpdateDocMode.QUIET_UPDATE as default for the UpdateDocMode load property, which was the default until JODConverter version 4.4.4.

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

formatRegistry, officeManager

Methods inherited from class java.lang.Object

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

Method Detail

build

public @NonNull LocalConverter build()

Specified by:

build in class org.jodconverter.core.job.AbstractConverter.AbstractConverterBuilder<LocalConverter.Builder>

applyDefaultLoadProperties

public @NonNull LocalConverter.Builder applyDefaultLoadProperties(boolean applyDefaultLoadProperties)

Specifies this converter will apply the default load properties when loading a source document.

Default: true

Default load properties are:

• Hidden: true
• ReadOnly: true
• UpdateDocMode: UpdateDocMode.NO_UPDATE

When building the load properties map that will be used to load a source document, the load properties of the input DocumentFormat, if any, are put in the map first. Then, the LocalConverter.DEFAULT_LOAD_PROPERTIES, if required, are added to the map. Finally, any properties specified in the loadProperty(String, Object) or loadProperties(Map) are put in the map.

Parameters:

applyDefaultLoadProperties - true to apply the default load properties false otherwise.

Returns:

This builder instance.

useUnsafeQuietUpdate

public @NonNull LocalConverter.Builder useUnsafeQuietUpdate(boolean useUnsafeQuietUpdate)

Specifies whether this converter will use the unsafe UpdateDocMode.QUIET_UPDATE as default for the UpdateDocMode load property, which was the default until JODConverter version 4.4.4.

See this article for more detail;s about the security issue:

A Tale of Exploitation in Spreadsheet File Conversions

Parameters:

useUnsafeQuietUpdate - true to use the unsafe quiet update property, false otherwise.

Returns:

This builder instance.

loadDocumentMode

public @NonNull LocalConverter.Builder loadDocumentMode(@Nullable LoadDocumentMode loadDocumentMode)

Specifies how a document is loaded/stored when converting a document, whether it is loaded assuming the office process has access to the file on disk or not. If not, the conversion process will use stream adapters

Default: LoadDocumentMode.AUTO

Parameters:

loadDocumentMode - The load document mode.

Returns:

This builder instance.

loadProperty

public @NonNull LocalConverter.Builder loadProperty(@NonNull String name,
                                                    @NonNull Object value)

Specifies a property, for this converter, that will be applied when a document is loaded during a conversion task, regardless of the input format of the document.

When building the load properties map that will be used to load a source document, the load properties of the input DocumentFormat, if any, are put in the map first. Then, the LocalConverter.DEFAULT_LOAD_PROPERTIES, if required, are added to the map. Finally, any properties specified in the loadProperty(String, Object) or loadProperties(Map) are put in the map.

Any property set here will override the property with the same name from the input document format or the default load properties.

Parameters:

name - The property name.

value - The property value.

Returns:

This builder instance.

loadProperties

public @NonNull LocalConverter.Builder loadProperties(@NonNull Map<String,Object> loadProperties)

Specifies properties, for this converter, that will be applied when a document is loaded during a conversion task, regardless of the input format of the document.

When building the load properties map that will be used to load a source document, the load properties of the input DocumentFormat, if any, are put in the map first. Then, the LocalConverter.DEFAULT_LOAD_PROPERTIES, if required, are added to the map. Finally, any properties specified in the loadProperty(String, Object) or loadProperties(Map) are put in the map.

Any property set here will override the property with the same name from the input document format or the default load properties.

Parameters:

loadProperties - A map containing the properties to apply when loading a document.

Returns:

This builder instance.

filterChain

public @NonNull LocalConverter.Builder filterChain(Filter... filters)

Specifies the filters to apply when converting a document. Filter may be used to modify the document before the conversion (after it has been loaded). Filters are applied in the same order they appear as arguments.

Parameters:

filters - The filters to be applied after the document is loaded and before it is stored (converted) in the new document format.

Returns:

This builder instance.

filterChain

public @NonNull LocalConverter.Builder filterChain(@NonNull FilterChain filterChain)

Specifies the whole filter chain to apply when converting a document. A FilterChain is used to modify the document before the conversion (after it has been loaded). Filters are applied in the same order they appear in the chain.

Parameters:

filterChain - The FilterChain to be applied after the document is loaded and before it is stored (converted) in the new document format.

Returns:

This builder instance.

storeProperty

public @NonNull LocalConverter.Builder storeProperty(@NonNull String name,
                                                     @NonNull Object value)

Specifies a property, for this converter, that will be applied when a document is stored during a conversion task, regardless of the output format of the document.

Custom properties are applied after the store properties of the target DocumentFormat, so any property set here will override the property with the same name from the document format.

Parameters:

name - The property name.

value - The property value.

Returns:

This builder instance.

storeProperties

public @NonNull LocalConverter.Builder storeProperties(@NonNull Map<String,Object> storeProperties)

Specifies the properties that will be applied when a document is stored during the conversion task, regardless of the output format of the document.

Custom properties are applied after the store properties of the target DocumentFormat, so any property set here will override the property with the same name from the document format.

Parameters:

storeProperties - A map containing the custom properties to apply when storing a document.

Returns:

This builder instance.