org.jodconverter.core.document

Class DocumentFormat

java.lang.Object

org.jodconverter.core.document.DocumentFormat

public final class DocumentFormat
extends Object

Contains the required information used to deal with a specific document format .

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static @NonNull DocumentFormat.Builder	builder() Creates a new builder instance.
static @NonNull DocumentFormat.Builder	builder(@NonNull DocumentFormat sourceFormat) Creates a new builder instance from the specified format.
static @NonNull DocumentFormat	copy(@NonNull DocumentFormat sourceFormat) Creates a new modifiable DocumentFormat from the specified format.
@NonNull String	getExtension() Gets the extension associated with the document format.
@NonNull List<String>	getExtensions() Gets the file name extensions of the document format.
@Nullable DocumentFamily	getInputFamily() Gets the input DocumentFamily of the document format.
@Nullable Map<String,Object>	getLoadProperties() Gets the properties required to load(open) a document of this format.
@NonNull String	getMediaType() Gets the media (mime) type of the format.
@NonNull String	getName() Gets the name of the format.
@Nullable Map<DocumentFamily,Map<String,Object>>	getStoreProperties() Gets the properties required to store(save) a document of this format to a document of supported families.
@Nullable Map<String,Object>	getStoreProperties(@NonNull DocumentFamily family) Gets the properties required to store(save) a document to this format from a document of the specified family.
@NonNull String	toString()
static @NonNull DocumentFormat	unmodifiableCopy(@NonNull DocumentFormat sourceFormat) Creates a new unmodifiable DocumentFormat from the specified format.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static @NonNull DocumentFormat.Builder builder()

Creates a new builder instance.

Returns:

A new builder instance.

builder

public static @NonNull DocumentFormat.Builder builder(@NonNull DocumentFormat sourceFormat)

Creates a new builder instance from the specified format.

Parameters:

sourceFormat - The source document format.

Returns:

A new builder instance.

copy

public static @NonNull DocumentFormat copy(@NonNull DocumentFormat sourceFormat)

Creates a new modifiable DocumentFormat from the specified format.

Parameters:

sourceFormat - The source document format.

Returns:

A DocumentFormat, which will be modifiable, unlike the default document formats are.

unmodifiableCopy

public static @NonNull DocumentFormat unmodifiableCopy(@NonNull DocumentFormat sourceFormat)

Creates a new unmodifiable DocumentFormat from the specified format.

Parameters:

sourceFormat - The source document format.

Returns:

A DocumentFormat, which will be unmodifiable, like the default document formats are.

getExtension

public @NonNull String getExtension()

Gets the extension associated with the document format. It will return the same extension as #getExtensions().get(0).

Returns:

A string that represents an extension.

getExtensions

public @NonNull List<String> getExtensions()

Gets the file name extensions of the document format.

Returns:

A list of string that represents the extensions.

getInputFamily

public @Nullable DocumentFamily getInputFamily()

Gets the input DocumentFamily of the document format.

Returns:

The input DocumentFamily of the document format.

getLoadProperties

public @Nullable Map<String,Object> getLoadProperties()

Gets the properties required to load(open) a document of this format.

Returns:

A map containing the properties to apply when loading a document of this format.

getMediaType

public @NonNull String getMediaType()

Gets the media (mime) type of the format.

Returns:

A string that represents the media type.

getName

public @NonNull String getName()

Gets the name of the format.

Returns:

A string that represents the name of the format.

getStoreProperties

public @Nullable Map<DocumentFamily,Map<String,Object>> getStoreProperties()

Gets the properties required to store(save) a document of this format to a document of supported families.

Returns:

A DocumentFamily/Map pairs containing the properties to apply when storing a document of this format, by DocumentFamily.

getStoreProperties

public @Nullable Map<String,Object> getStoreProperties(@NonNull DocumentFamily family)

Gets the properties required to store(save) a document to this format from a document of the specified family.

Parameters:

family - The DocumentFamily for which the properties are get.

Returns:

A map containing the properties to apply when storing a document to this format.

toString

public @NonNull String toString()

Overrides:

toString in class Object