org.aoju.bus.office.magic.family

Class DocumentFormat.Builder

java.lang.Object

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

Enclosing class:

DocumentFormat

public static final class DocumentFormat.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
DocumentFormat	build()
DocumentFormat.Builder	extension(String extension) 指定与文档格式关联的扩展名.
DocumentFormat.Builder	from(DocumentFormat sourceFormat) 通过复制指定文档格式的属性来初始化生成器.
DocumentFormat.Builder	inputFamily(FamilyType inputFamily) 指定与文档格式关联的输入(文档加载时)DocumentFamily.
DocumentFormat.Builder	loadProperty(String name, Object value) 向生成器添加一个属性，该属性将在加载(打开)这种格式的文档时应用.
DocumentFormat.Builder	mediaType(String mediaType) 指定文档格式的媒体(mime)类型
DocumentFormat.Builder	name(String name) 指定文档格式的名称.
DocumentFormat.Builder	storeProperty(FamilyType family, String name, Object value) 向生成器添加一个属性，该属性将在从指定集合的文档存储(保存)为这种格式的文档时应用.
DocumentFormat.Builder	unmodifiable(boolean unmodifiable) 指定文档格式在创建后是否不可修改。默认为true.

Methods inherited from class java.lang.Object

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

Method Detail

build

public DocumentFormat build()

from

public DocumentFormat.Builder from(DocumentFormat sourceFormat)

通过复制指定文档格式的属性来初始化生成器.

Parameters:

sourceFormat - 源文档格式不能为空.

Returns:

当前构造器实例.

extension

public DocumentFormat.Builder extension(String extension)

指定与文档格式关联的扩展名.

Parameters:

extension - 扩展名不能为空.

Returns:

当前构造器实例.

inputFamily

public DocumentFormat.Builder inputFamily(FamilyType inputFamily)

指定与文档格式关联的输入(文档加载时)DocumentFamily.

Parameters:

inputFamily - DocumentFamily不能为空.

Returns:

当前构造器实例.

loadProperty

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

向生成器添加一个属性，该属性将在加载(打开)这种格式的文档时应用.

Parameters:

name - 属性名不能为空.

value - 属性值可以为空。如果为空，它将从映射中删除该属性.

Returns:

当前构造器实例.

mediaType

public DocumentFormat.Builder mediaType(String mediaType)

指定文档格式的媒体(mime)类型

Parameters:

mediaType - 表示媒体类型的字符串不能为空.

Returns:

当前构造器实例.

name

public DocumentFormat.Builder name(String name)

指定文档格式的名称.

Parameters:

name - 文档格式的名称不能为空.

Returns:

当前构造器实例.

unmodifiable

public DocumentFormat.Builder unmodifiable(boolean unmodifiable)

指定文档格式在创建后是否不可修改。默认为true.

Parameters:

unmodifiable - true 文档在创建后不能修改格式, false尚未创建则可以修改.

Returns:

当前构造器实例.

storeProperty

public DocumentFormat.Builder storeProperty(FamilyType family,
                                            String name,
                                            Object value)

向生成器添加一个属性，该属性将在从指定集合的文档存储(保存)为这种格式的文档时应用.

Parameters:

family - 源(加载的)文档的文档族不能为空.

name - 文档格式的名称不能为空.

value - 属性值可以为空。如果为空，它将从映射中删除该属性.

Returns:

当前构造器实例.