Builder (bus-all 5.5.3 API)

java.lang.Object
- org.aoju.bus.office.Builder

```
public final class Builder
extends Object
```
为office提供辅助功能.

Since:

JDK 1.8+

Version:

5.5.3

Author:

Kimi Liu

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BASE_SERVICE`
`static String`	`CALC_SERVICE`
`static boolean`	`DEFAULT_CLOSE_STREAM`
`static long`	`DEFAULT_CONNECT_TIMEOUT` 连接到office时的默认超时.
`static boolean`	`DEFAULT_DISABLE_OPENGL` 有关OpenGL使用的默认行为.
`static boolean`	`DEFAULT_KILL_EXISTING_PROCESS` 启动具有相同URL的office进程时的默认行为已经存在.
`static int`	`DEFAULT_MAX_TASKS_PER_PROCESS` office进程在重新启动之前可以执行的默认最大任务数.
`static String`	`DEFAULT_PIPE_NAME` 连接到office的默认管道名称.
`static int`	`DEFAULT_PORT_NUMBER` 连接到office的默认端口号.
`static long`	`DEFAULT_PROCESS_RETRY_INTERVAL` 执行进程调用时每次尝试之间的默认延迟(启动/终止).
`static long`	`DEFAULT_PROCESS_TIMEOUT` 执行进程调用时的默认超时(启动/终止).
`static long`	`DEFAULT_RETRY_INTERVAL` 每次尝试连接之间的默认延迟.
`static long`	`DEFAULT_TASK_EXECUTION_TIMEOUT` 处理任务时的默认超时.
`static long`	`DEFAULT_TASK_QUEUE_TIMEOUT` 转换队列中任务的默认最大生存时间.
`static String`	`DRAW_SERVICE`
`static String`	`ERROR_MESSAGE_STORE`
`static String`	`FAILURE`
`static String`	`FILTER_DATA`
`static String`	`FILTER_DATA_PREFIX_PARAM`
`static String`	`IMPRESS_SERVICE`
`static String`	`LOAD_PROPERTIES_PREFIX_PARAM`
`static String`	`MATH_SERVICE`
`static long`	`MAX_PROCESS_RETRY_INTERVAL` 执行进程调用时每次尝试之间的最大延迟(开始/终止).
`static long`	`MIN_PROCESS_RETRY_INTERVAL` 执行进程调用时每次尝试之间的最小延迟值(开始/终止).
`static String`	`NODE_L10N`
`static String[]`	`NODE_PATHS`
`static String`	`NODE_PRODUCT`
`static long`	`PID_NOT_FOUND`
`static long`	`PID_UNKNOWN`
`static String`	`STORE_PROPERTIES_PREFIX_PARAM`
`static String`	`SUCCESS`
`static String`	`UNKNOWN_SERVICE`
`static String`	`WRITER_SERVICE`

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static UnoUrl[]`	`buildOfficeUrls(int[] portNumbers, String[] pipeNames)` 从端口号数组和管道名称数组构建`UnoUrl`数组.
`static ProcessManager`	`findBestProcessManager()` 找到最好的进程管理器，它将用于检索进程PID并通过PID杀死进程.
`static File`	`getDefaultOfficeHome()` 获取自动检测的默认office主目录.
`static FamilyType`	`getDocumentFamily(com.sun.star.lang.XComponent document)` 获取指定文档的`FamilyType`.
`static File`	`getOfficeExecutable(File officeHome)` 获取office安装中的office可执行文件.
`static com.sun.star.beans.PropertyValue`	`property(String name, Object value)` 使用指定的名称和值创建`PropertyValue`.
`static com.sun.star.beans.PropertyValue[]`	`toUnoProperties(Map<String,Object> properties)` 将常规java映射转换为`PropertyValue`数组，可用作带有UNO接口类型的参数.
`static String`	`toUrl(File file)` 按照office的要求，从指定文件构造URL.
`static void`	`validateOfficeHome(File officeHome)` 验证指定的文件实例是否是有效的office主目录.
`static void`	`validateOfficeTemplateProfileDirectory(File templateProfileDir)` 验证指定的文件实例是有效的office模板配置文件目录.
`static void`	`validateOfficeWorkingDirectory(File workingDir)` 验证指定的文件实例是否是有效的office工作目录.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UNKNOWN_SERVICE
```
public static final String UNKNOWN_SERVICE
```
    See Also:
    
    Constant Field Values
  - WRITER_SERVICE
```
public static final String WRITER_SERVICE
```
    See Also:
    
    Constant Field Values
  - BASE_SERVICE
```
public static final String BASE_SERVICE
```
    See Also:
    
    Constant Field Values
  - CALC_SERVICE
```
public static final String CALC_SERVICE
```
    See Also:
    
    Constant Field Values
  - DRAW_SERVICE
```
public static final String DRAW_SERVICE
```
    See Also:
    
    Constant Field Values
  - IMPRESS_SERVICE
```
public static final String IMPRESS_SERVICE
```
    See Also:
    
    Constant Field Values
  - MATH_SERVICE
```
public static final String MATH_SERVICE
```
    See Also:
    
    Constant Field Values
  - NODE_PRODUCT
```
public static final String NODE_PRODUCT
```
    See Also:
    
    Constant Field Values
  - NODE_L10N
```
public static final String NODE_L10N
```
    See Also:
    
    Constant Field Values
  - NODE_PATHS
```
public static final String[] NODE_PATHS
```
  - SUCCESS
```
public static final String SUCCESS
```
    See Also:
    
    Constant Field Values
  - FAILURE
```
public static final String FAILURE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PORT_NUMBER
```
public static final int DEFAULT_PORT_NUMBER
```
    连接到office的默认端口号.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PIPE_NAME
```
public static final String DEFAULT_PIPE_NAME
```
    连接到office的默认管道名称.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CONNECT_TIMEOUT
```
public static final long DEFAULT_CONNECT_TIMEOUT
```
    连接到office时的默认超时. 默认2分钟
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RETRY_INTERVAL
```
public static final long DEFAULT_RETRY_INTERVAL
```
    每次尝试连接之间的默认延迟. 默认: 0.25秒
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PROCESS_TIMEOUT
```
public static final long DEFAULT_PROCESS_TIMEOUT
```
    执行进程调用时的默认超时(启动/终止). 默认:2分钟
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PROCESS_RETRY_INTERVAL
```
public static final long DEFAULT_PROCESS_RETRY_INTERVAL
```
    执行进程调用时每次尝试之间的默认延迟(启动/终止). 默认:0.25 秒
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_TASKS_PER_PROCESS
```
public static final int DEFAULT_MAX_TASKS_PER_PROCESS
```
    office进程在重新启动之前可以执行的默认最大任务数.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DISABLE_OPENGL
```
public static final boolean DEFAULT_DISABLE_OPENGL
```
    有关OpenGL使用的默认行为.
    
    See Also:
    
    Constant Field Values
  - MIN_PROCESS_RETRY_INTERVAL
```
public static final long MIN_PROCESS_RETRY_INTERVAL
```
    执行进程调用时每次尝试之间的最小延迟值(开始/终止). 默认:没有延迟
    
    See Also:
    
    Constant Field Values
  - MAX_PROCESS_RETRY_INTERVAL
```
public static final long MAX_PROCESS_RETRY_INTERVAL
```
    执行进程调用时每次尝试之间的最大延迟(开始/终止). 默认:10秒
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TASK_QUEUE_TIMEOUT
```
public static final long DEFAULT_TASK_QUEUE_TIMEOUT
```
    转换队列中任务的默认最大生存时间. 默认:30秒
    
    See Also:
    
    Constant Field Values
  - DEFAULT_KILL_EXISTING_PROCESS
```
public static final boolean DEFAULT_KILL_EXISTING_PROCESS
```
    启动具有相同URL的office进程时的默认行为已经存在.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TASK_EXECUTION_TIMEOUT
```
public static final long DEFAULT_TASK_EXECUTION_TIMEOUT
```
    处理任务时的默认超时. 默认:2分钟
    
    See Also:
    
    Constant Field Values
  - ERROR_MESSAGE_STORE
```
public static final String ERROR_MESSAGE_STORE
```
    See Also:
    
    Constant Field Values
  - FILTER_DATA
```
public static final String FILTER_DATA
```
    See Also:
    
    Constant Field Values
  - FILTER_DATA_PREFIX_PARAM
```
public static final String FILTER_DATA_PREFIX_PARAM
```
    See Also:
    
    Constant Field Values
  - LOAD_PROPERTIES_PREFIX_PARAM
```
public static final String LOAD_PROPERTIES_PREFIX_PARAM
```
    See Also:
    
    Constant Field Values
  - STORE_PROPERTIES_PREFIX_PARAM
```
public static final String STORE_PROPERTIES_PREFIX_PARAM
```
    See Also:
    
    Constant Field Values
  - PID_NOT_FOUND
```
public static final long PID_NOT_FOUND
```
    See Also:
    
    Constant Field Values
  - PID_UNKNOWN
```
public static final long PID_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CLOSE_STREAM
```
public static final boolean DEFAULT_CLOSE_STREAM
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - findBestProcessManager
```
public static ProcessManager findBestProcessManager()
```
    找到最好的进程管理器，它将用于检索进程PID并通过PID杀死进程.
    
    Returns:
    
    最好的进程管理器根据当前的操作系统.
  - buildOfficeUrls
```
public static UnoUrl[] buildOfficeUrls(int[] portNumbers,
                                       String[] pipeNames)
```
    从端口号数组和管道名称数组构建UnoUrl数组.
    
    Parameters:
    
    portNumbers - 用于创建office url的端口号可能为空.
    
    pipeNames - 用于创建office url的管道名称可能为空.
    
    Returns:
    
    office URL的数组。如果两个参数都为空，则返回一个带有单个office URL的数组，使用默认端口号8102.
  - getDefaultOfficeHome
```
public static File getDefaultOfficeHome()
```
    获取自动检测的默认office主目录.
    
    Returns:
    
    File实例，它是第一次检测到的office安装所在的目录.
  - getDocumentFamily
```
public static FamilyType getDocumentFamily(com.sun.star.lang.XComponent document)
                                    throws InstrumentException
```
    获取指定文档的FamilyType.
    
    Parameters:
    
    document - 文档类型.
    
    Returns:
    
    指定文档的FamilyType.
    
    Throws:
    
    InstrumentException - 如果无法检索文档族.
  - getOfficeExecutable
```
public static File getOfficeExecutable(File officeHome)
```
    获取office安装中的office可执行文件.
    
    Parameters:
    
    officeHome - office安装的根(主)目录.
    
    Returns:
    
    可执行文件的实例.
  - property
```
public static com.sun.star.beans.PropertyValue property(String name,
                                                        Object value)
```
    使用指定的名称和值创建PropertyValue.
    
    Parameters:
    
    name - 属性名.
    
    value - 属性值.
    
    Returns:
    
    创建的PropertyValue.
  - toUnoProperties
```
public static com.sun.star.beans.PropertyValue[] toUnoProperties(Map<String,Object> properties)
```
    将常规java映射转换为PropertyValue数组，可用作带有UNO接口类型的参数.
    
    Parameters:
    
    properties - 要转换的map.
    
    Returns:
    
    PropertyValue的数组.
  - toUrl
```
public static String toUrl(File file)
```
    按照office的要求，从指定文件构造URL.
    
    Parameters:
    
    file - 将为其构造URL的文件.
    
    Returns:
    
    有效的office网址.
  - validateOfficeHome
```
public static void validateOfficeHome(File officeHome)
```
    验证指定的文件实例是否是有效的office主目录.
    
    Parameters:
    
    officeHome - 验证office主目录.
    
    Throws:
    
    IllegalStateException - 如果指定的目录不是有效的office主目录.
  - validateOfficeTemplateProfileDirectory
```
public static void validateOfficeTemplateProfileDirectory(File templateProfileDir)
```
    验证指定的文件实例是有效的office模板配置文件目录.
    
    Parameters:
    
    templateProfileDir - 要验证的目录.
    
    Throws:
    
    IllegalStateException - 如果指定的目录不是有效的office模板配置文件目录.
  - validateOfficeWorkingDirectory
```
public static void validateOfficeWorkingDirectory(File workingDir)
```
    验证指定的文件实例是否是有效的office工作目录.
    
    Parameters:
    
    workingDir - 要验证的目录.
    
    Throws:
    
    IllegalStateException - 如果指定的目录不是有效的office工作目录.

Class Builder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNKNOWN_SERVICE

WRITER_SERVICE

BASE_SERVICE

CALC_SERVICE

DRAW_SERVICE

IMPRESS_SERVICE

MATH_SERVICE

NODE_PRODUCT

NODE_L10N

NODE_PATHS

SUCCESS

FAILURE

DEFAULT_PORT_NUMBER

DEFAULT_PIPE_NAME

DEFAULT_CONNECT_TIMEOUT

DEFAULT_RETRY_INTERVAL

DEFAULT_PROCESS_TIMEOUT

DEFAULT_PROCESS_RETRY_INTERVAL

DEFAULT_MAX_TASKS_PER_PROCESS

DEFAULT_DISABLE_OPENGL

MIN_PROCESS_RETRY_INTERVAL

MAX_PROCESS_RETRY_INTERVAL

DEFAULT_TASK_QUEUE_TIMEOUT

DEFAULT_KILL_EXISTING_PROCESS

DEFAULT_TASK_EXECUTION_TIMEOUT

ERROR_MESSAGE_STORE

FILTER_DATA

FILTER_DATA_PREFIX_PARAM

LOAD_PROPERTIES_PREFIX_PARAM

STORE_PROPERTIES_PREFIX_PARAM

PID_NOT_FOUND

PID_UNKNOWN

DEFAULT_CLOSE_STREAM

Constructor Detail

Builder

Method Detail

findBestProcessManager

buildOfficeUrls

getDefaultOfficeHome

getDocumentFamily

getOfficeExecutable

property

toUnoProperties

toUrl

validateOfficeHome

validateOfficeTemplateProfileDirectory

validateOfficeWorkingDirectory