org.jodconverter.core.document

Class DocumentFormat.Builder

java.lang.Object

org.jodconverter.core.document.DocumentFormat.Builder

Enclosing class:

DocumentFormat

public static final class DocumentFormat.Builder
extends Object

A builder for constructing a DocumentFormat.

See Also:

DocumentFormat

Method Summary

Modifier and Type	Method and Description
@NonNull DocumentFormat	build() Creates the converter that is specified by this builder.
@NonNull DocumentFormat.Builder	extension(@NonNull String extension) Specifies the extension associated with the document format.
@NonNull DocumentFormat.Builder	from(@NonNull DocumentFormat sourceFormat) Initializes the builder by copying the properties of the specified document format.
@NonNull DocumentFormat.Builder	inputFamily(@Nullable DocumentFamily inputFamily) Specifies the input (when a document is loaded) DocumentFamily associated with the document format.
@NonNull DocumentFormat.Builder	loadFilterName(@Nullable String value) Sets the FilterName property to the builder that will be applied when loading (open) a document of this format.
@NonNull DocumentFormat.Builder	loadFilterOptions(@Nullable String value) Sets the FilterOptions property to the builder that will be applied when loading (open) a document of this format.
@NonNull DocumentFormat.Builder	loadProperty(@NonNull String name, @Nullable Object value) Adds a property to the builder that will be applied when loading (open) a document of this format.
@NonNull DocumentFormat.Builder	mediaType(@NonNull String mediaType) Specifies the media (mime) type of the document format.
@NonNull DocumentFormat.Builder	name(@NonNull String name) Specifies the name of the document format.
@NonNull DocumentFormat.Builder	storeFilterName(@NonNull DocumentFamily documentFamily, @Nullable String value) Sets the FilterName property that will be applied when storing (save) a document to this format from a document of the specified family.
@NonNull DocumentFormat.Builder	storeFilterOptions(@NonNull DocumentFamily documentFamily, @Nullable String value) Sets the FilterOptions property that will be applied when storing (save) a document to this format from a document of the specified family.
@NonNull DocumentFormat.Builder	storeProperty(@NonNull DocumentFamily documentFamily, @NonNull String name, @Nullable Object value) Adds a property to the builder that will be applied when storing (save) a document to this format from a document of the specified family.
@NonNull DocumentFormat.Builder	unmodifiable(boolean unmodifiable) Specifies whether the document format is unmodifiable after creation.

Methods inherited from class java.lang.Object

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

Method Detail

build

public @NonNull DocumentFormat build()

Creates the converter that is specified by this builder.

Returns:

The converter that is specified by this builder.

from

public @NonNull DocumentFormat.Builder from(@NonNull DocumentFormat sourceFormat)

Initializes the builder by copying the properties of the specified document format.

Parameters:

sourceFormat - The source document format, cannot be null.

Returns:

This builder instance.

extension

public @NonNull DocumentFormat.Builder extension(@NonNull String extension)

Specifies the extension associated with the document format.

Parameters:

extension - The extension, cannot be null.

Returns:

This builder instance.

inputFamily

public @NonNull DocumentFormat.Builder inputFamily(@Nullable DocumentFamily inputFamily)

Specifies the input (when a document is loaded) DocumentFamily associated with the document format.

Parameters:

inputFamily - The DocumentFamily, may be null.

Returns:

This builder instance.

loadProperty

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

Adds a property to the builder that will be applied when loading (open) a document of this format.

Parameters:

name - The property name, cannot be null.

value - The property value, may be null. If null, it will REMOVE the property from the map.

Returns:

This builder instance.

loadFilterName

public @NonNull DocumentFormat.Builder loadFilterName(@Nullable String value)

Sets the FilterName property to the builder that will be applied when loading (open) a document of this format.

See File Conversion Filter Names

Parameters:

value - The FilterName value, may be null. If null, it will REMOVE the FilterName from the map.

Returns:

This builder instance.

loadFilterOptions

public @NonNull DocumentFormat.Builder loadFilterOptions(@Nullable String value)

Sets the FilterOptions property to the builder that will be applied when loading (open) a document of this format.

Parameters:

value - The FilterOptions value, may be null. If null, it will REMOVE the FilterName from the map.

Returns:

This builder instance.

mediaType

public @NonNull DocumentFormat.Builder mediaType(@NonNull String mediaType)

Specifies the media (mime) type of the document format.

Parameters:

mediaType - A string that represents the media type, cannot be null.

Returns:

This builder instance.

name

public @NonNull DocumentFormat.Builder name(@NonNull String name)

Specifies the name of the document format.

Parameters:

name - The name of the document format, cannot be null.

Returns:

This builder instance.

unmodifiable

public @NonNull DocumentFormat.Builder unmodifiable(boolean unmodifiable)

Specifies whether the document format is unmodifiable after creation. Default to true.

Parameters:

unmodifiable - true if the created document format cannot be modified after creation, false otherwise.

Returns:

This builder instance.

storeProperty

public @NonNull DocumentFormat.Builder storeProperty(@NonNull DocumentFamily documentFamily,
                                                     @NonNull String name,
                                                     @Nullable Object value)

Adds a property to the builder that will be applied when storing (save) a document to this format from a document of the specified family.

Parameters:

documentFamily - The document family of the source (loaded) document, cannot be null.

name - The property name, cannot be null.

value - The property value, may be null. If null, it will REMOVE the property from the map.

Returns:

This builder instance.

storeFilterName

public @NonNull DocumentFormat.Builder storeFilterName(@NonNull DocumentFamily documentFamily,
                                                       @Nullable String value)

Sets the FilterName property that will be applied when storing (save) a document to this format from a document of the specified family.

See File Conversion Filter Names

Parameters:

documentFamily - The document family of the source (loaded) document, cannot be null.

value - The FilterName value, may be null. If null, it will REMOVE the property from the map.

Returns:

This builder instance.

storeFilterOptions

public @NonNull DocumentFormat.Builder storeFilterOptions(@NonNull DocumentFamily documentFamily,
                                                          @Nullable String value)

Sets the FilterOptions property that will be applied when storing (save) a document to this format from a document of the specified family.

Parameters:

documentFamily - The document family of the source (loaded) document, cannot be null.

value - The FilterOptions value, may be null. If null, it will REMOVE the property from the map.

Returns:

This builder instance.