public class DocumentFormat
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
DocumentFormat.Builder
A builder for constructing a
DocumentFormat . |
Modifier and Type | Method and Description |
---|---|
static DocumentFormat.Builder |
builder()
Creates a new builder instance.
|
static DocumentFormat |
copy(DocumentFormat sourceFormat)
Creates a new modifiable
DocumentFormat from the specified format. |
java.lang.String |
getExtension()
Gets the extension associated with the document format.
|
DocumentFamily |
getInputFamily()
Gets the input DocumentFamily of the document format.
|
java.util.Map<java.lang.String,java.lang.Object> |
getLoadProperties()
Gets the properties required to load(open) a document of this format.
|
java.lang.String |
getMediaType()
Gets the media (mime) type of the format.
|
java.lang.String |
getName()
Gets the name of the format.
|
java.util.Map<DocumentFamily,java.util.Map<java.lang.String,java.lang.Object>> |
getStoreProperties()
Gets the properties required to store(save) a document of this format to a document of
supported families.
|
java.util.Map<java.lang.String,java.lang.Object> |
getStoreProperties(DocumentFamily family)
Gets the properties required to store(save) a document to this format from a document of the
specified family.
|
java.lang.String |
toString() |
static DocumentFormat |
unmodifiableCopy(DocumentFormat sourceFormat)
Creates a new unmodifiable
DocumentFormat from the specified format. |
public static DocumentFormat.Builder builder()
public static DocumentFormat copy(DocumentFormat sourceFormat)
DocumentFormat
from the specified format.sourceFormat
- The source document format.DocumentFormat
, which will be modifiable, unlike the default document formats
are.public static DocumentFormat unmodifiableCopy(DocumentFormat sourceFormat)
DocumentFormat
from the specified format.sourceFormat
- The source document format.DocumentFormat
, which will be unmodifiable, like the default document formats
are.public java.lang.String getExtension()
public DocumentFamily getInputFamily()
public java.util.Map<java.lang.String,java.lang.Object> getLoadProperties()
public java.lang.String getMediaType()
public java.lang.String getName()
public java.util.Map<DocumentFamily,java.util.Map<java.lang.String,java.lang.Object>> getStoreProperties()
public java.util.Map<java.lang.String,java.lang.Object> getStoreProperties(DocumentFamily family)
family
- The DocumentFamily for which the properties are get.public java.lang.String toString()
toString
in class java.lang.Object