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	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	loadProperties(@NonNull Map<String,Object> loadProperties) Specifies the load 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	storeProperties(@NonNull Map<String,Object> storeProperties) Specifies the properties that will be applied when a document is stored during the conversion task.

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>

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.

loadProperties

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

Specifies the load 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.

Using this function will replace the default load properties map.

Parameters:

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

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.

Custom properties are applied after the store properties of the target DocumentFormat.

Parameters:

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

Returns:

This builder instance.