org.aoju.bus.office.magic.family

Class DocumentFormat

java.lang.Object

org.aoju.bus.office.magic.family.DocumentFormat

public class DocumentFormat
extends Object

包含处理特定文档格式所需的信息

Since:

JDK 1.8+

Version:

5.6.2

Author:

Kimi Liu

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentFormat.Builder

Field Summary

Fields

Modifier and Type	Field and Description
List<String>	extensions
FamilyType	inputFamily
Map<String,Object>	loadProperties
String	mediaType
String	name
Map<FamilyType,Map<String,Object>>	storeProperties

Constructor Summary

Constructors

Constructor and Description
DocumentFormat()

Method Summary

Modifier and Type	Method and Description
static DocumentFormat.Builder	builder() 创建一个新的生成器实例.
static DocumentFormat	copy(DocumentFormat sourceFormat) 从指定的格式创建一个新的可修改的DocumentFormat.
String	getExtension() 获取与文档格式关联的扩展名。它将返回与#getExtensions().get(0)相同的扩展名.
List<String>	getExtensions() 获取文档格式的文件名扩展名.
FamilyType	getInputFamily() 获取文档格式的输入DocumentFamily.
Map<String,Object>	getLoadProperties() 获取加载(打开)这种格式文档所需的属性.
String	getMediaType() 获取格式的媒体(mime)类型.
String	getName() 获取格式的名称.
Map<FamilyType,Map<String,Object>>	getStoreProperties() 获取将这种格式的文档存储(保存)到受支持的集合文档所需的属性.
Map<String,Object>	getStoreProperties(FamilyType family) 从指定集合的文档中获取将文档存储(保存)为这种格式所需的属性.
String	toString()
static DocumentFormat	unmodifiableCopy(DocumentFormat sourceFormat) 从指定格式创建一个新的不可修改的DocumentFormat.

Methods inherited from class java.lang.Object

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

Field Detail

name

public String name

extensions

public List<String> extensions

mediaType

public String mediaType

inputFamily

public FamilyType inputFamily

loadProperties

public Map<String,Object> loadProperties

storeProperties

public Map<FamilyType,Map<String,Object>> storeProperties

Constructor Detail

DocumentFormat

public DocumentFormat()

Method Detail

builder

public static DocumentFormat.Builder builder()

创建一个新的生成器实例.

Returns:

新的生成器实例.

copy

public static DocumentFormat copy(DocumentFormat sourceFormat)

从指定的格式创建一个新的可修改的DocumentFormat.

Parameters:

sourceFormat - 源文档格式.

Returns:

DocumentFormat，与默认的文档格式不同，它是可修改的.

unmodifiableCopy

public static DocumentFormat unmodifiableCopy(DocumentFormat sourceFormat)

从指定格式创建一个新的不可修改的DocumentFormat.

Parameters:

sourceFormat - 源文档格式.

Returns:

DocumentFormat，与默认的文档格式不同，它是可修改的.

getExtension

public String getExtension()

获取与文档格式关联的扩展名。它将返回与#getExtensions().get(0)相同的扩展名.

Returns:

表示扩展名的字符串.

getExtensions

public List<String> getExtensions()

获取文档格式的文件名扩展名.

Returns:

表示扩展的字符串列表.

getInputFamily

public FamilyType getInputFamily()

获取文档格式的输入DocumentFamily.

Returns:

文档格式.

getLoadProperties

public Map<String,Object> getLoadProperties()

获取加载(打开)这种格式文档所需的属性.

Returns:

包含加载这种格式的文档时要应用的属性的映射.

getMediaType

public String getMediaType()

获取格式的媒体(mime)类型.

Returns:

表示媒体类型的字符串.

getName

public String getName()

获取格式的名称.

Returns:

表示格式名称的字符串.

getStoreProperties

public Map<FamilyType,Map<String,Object>> getStoreProperties()

获取将这种格式的文档存储(保存)到受支持的集合文档所需的属性.

Returns:

DocumentFamily/Map对，包含在按DocumentFamily存储这种格式的文档时要应用的属性.

getStoreProperties

public Map<String,Object> getStoreProperties(FamilyType family)

从指定集合的文档中获取将文档存储(保存)为这种格式所需的属性.

Parameters:

family - 属性获取的DocumentFamily.

Returns:

包含将文档存储为这种格式时要应用的属性的映射.

toString

public String toString()

Overrides:

toString in class Object