org.aoju.bus.office.bridge

Class LocalOfficePoolManager.Builder

java.lang.Object

org.aoju.bus.office.metric.AbstractOfficeManager.AbstractOfficeManagerBuilder<B>

org.aoju.bus.office.metric.AbstractOfficePoolManager.AbstractOfficeManagerPoolBuilder<LocalOfficePoolManager.Builder>

org.aoju.bus.office.bridge.LocalOfficePoolManager.Builder

Enclosing class:

LocalOfficePoolManager

public static final class LocalOfficePoolManager.Builder
extends AbstractOfficePoolManager.AbstractOfficeManagerPoolBuilder<LocalOfficePoolManager.Builder>

用于构造LocalOfficePoolManager的生成器

See Also:

LocalOfficePoolManager

Field Summary

Fields inherited from class org.aoju.bus.office.metric.AbstractOfficePoolManager.AbstractOfficeManagerPoolBuilder

taskExecutionTimeout, taskQueueTimeout

Fields inherited from class org.aoju.bus.office.metric.AbstractOfficeManager.AbstractOfficeManagerBuilder

install, workingDir

Method Summary

Modifier and Type	Method and Description
LocalOfficePoolManager	build() 创建此生成器指定的管理器
LocalOfficePoolManager.Builder	disableOpengl(boolean disableOpengl) 指定在启动新office进程时是否必须禁用OpenGL.
LocalOfficePoolManager.Builder	killExistingProcess(boolean killExistingProcess) 指定在为相同连接字符串启动新office进程时是否终止现有的office进程.
LocalOfficePoolManager.Builder	maxTasksPerProcess(int maxTasksPerProcess) 指定office流程在重新启动之前可以执行的最大任务数.
LocalOfficePoolManager.Builder	officeHome(File officeHome) 指定office主目录(office安装).
LocalOfficePoolManager.Builder	officeHome(String officeHome) 指定office主目录(office安装).
LocalOfficePoolManager.Builder	pipeNames(String... pipeNames) 指定将用于与office通信的管道名称。将为每个管道名称启动一个office实例.
LocalOfficePoolManager.Builder	portNumbers(int... portNumbers) 指定将用于与office通信的端口号。将为每个端口号启动office实例.
LocalOfficePoolManager.Builder	processManager(ProcessManager processManager) 提供特定的ProcessManager实现，用于处理office进程(检索PID、终止进程).
LocalOfficePoolManager.Builder	processManager(String processManagerClass) 提供自定义ProcessManager实现，该实现可能不包括在标准JODConverter发行版中.
LocalOfficePoolManager.Builder	processRetryInterval(long processRetryInterval) 指定尝试执行office流程调用(开始/终止)时每次尝试之间的延迟(以毫秒为单位).
LocalOfficePoolManager.Builder	processTimeout(long processTimeout) 指定尝试执行office流程调用(启动/终止)时的超时时间，以毫秒为单位.
LocalOfficePoolManager.Builder	runAsArgs(String... runAsArgs) 指定将与unix命令一起使用的sudo参数.
LocalOfficePoolManager.Builder	templateProfileDir(File templateProfileDir) 指定要复制到要创建的临时office配置文件目录的目录.
LocalOfficePoolManager.Builder	templateProfileDir(String templateProfileDir) 指定要复制到要创建的临时office配置文件目录的目录.
LocalOfficePoolManager.Builder	templateProfileDirOrDefault(File templateProfileDir) 指定要复制到要创建的临时office配置文件目录的目录。如果给定的templateProfileDir无效， 则将忽略它并应用默认行为.
LocalOfficePoolManager.Builder	templateProfileDirOrDefault(String templateProfileDir) 指定要复制到要创建的临时office配置文件目录的目录。如果给定的templateProfileDir无效， 则将忽略它并应用默认行为.

Methods inherited from class org.aoju.bus.office.metric.AbstractOfficePoolManager.AbstractOfficeManagerPoolBuilder

taskExecutionTimeout, taskQueueTimeout

Methods inherited from class org.aoju.bus.office.metric.AbstractOfficeManager.AbstractOfficeManagerBuilder

install, workingDir, workingDir

Methods inherited from class java.lang.Object

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

Method Detail

build

public LocalOfficePoolManager build()

Description copied from class: AbstractOfficePoolManager.AbstractOfficeManagerPoolBuilder

创建此生成器指定的管理器

Specified by:

build in class AbstractOfficePoolManager.AbstractOfficeManagerPoolBuilder<LocalOfficePoolManager.Builder>

Returns:

由该生成器指定的管理器

pipeNames

public LocalOfficePoolManager.Builder pipeNames(String... pipeNames)

指定将用于与office通信的管道名称。将为每个管道名称启动一个office实例.

Parameters:

pipeNames - 要使用的管道名称.

Returns:

构造器实例.

portNumbers

public LocalOfficePoolManager.Builder portNumbers(int... portNumbers)

指定将用于与office通信的端口号。将为每个端口号启动office实例.

Parameters:

portNumbers - 要使用的端口号.

Returns:

构造器实例.

officeHome

public LocalOfficePoolManager.Builder officeHome(File officeHome)

指定office主目录(office安装).

Parameters:

officeHome - 要设置的新主目录.

Returns:

构造器实例.

officeHome

public LocalOfficePoolManager.Builder officeHome(String officeHome)

指定office主目录(office安装).

Parameters:

officeHome - 要设置的新主目录.

Returns:

构造器实例.

processManager

public LocalOfficePoolManager.Builder processManager(ProcessManager processManager)

提供特定的ProcessManager实现，用于处理office进程(检索PID、终止进程).

Parameters:

processManager - 所提供的流程管理器.

Returns:

构造器实例.

processManager

public LocalOfficePoolManager.Builder processManager(String processManagerClass)

提供自定义ProcessManager实现，该实现可能不包括在标准JODConverter发行版中.

Parameters:

processManagerClass - 提供的流程管理器的类型。类必须实现ProcessManager接口， 必须在类路径上(或者更具体地说，可以从当前类加载器访问)， 并且必须有一个默认的公共构造函数.

Returns:

构造器实例.

See Also:

ProcessManager, AbstractProcessManager

runAsArgs

public LocalOfficePoolManager.Builder runAsArgs(String... runAsArgs)

指定将与unix命令一起使用的sudo参数.

Parameters:

runAsArgs - unix操作系统的sudo参数.

Returns:

构造器实例.

templateProfileDir

public LocalOfficePoolManager.Builder templateProfileDir(File templateProfileDir)

指定要复制到要创建的临时office配置文件目录的目录.

Parameters:

templateProfileDir - 新的模板配置文件目录.

Returns:

构造器实例.

templateProfileDir

public LocalOfficePoolManager.Builder templateProfileDir(String templateProfileDir)

指定要复制到要创建的临时office配置文件目录的目录.

Parameters:

templateProfileDir - 新的模板配置文件目录.

Returns:

构造器实例.

templateProfileDirOrDefault

public LocalOfficePoolManager.Builder templateProfileDirOrDefault(File templateProfileDir)

指定要复制到要创建的临时office配置文件目录的目录。如果给定的templateProfileDir无效， 则将忽略它并应用默认行为.

Parameters:

templateProfileDir - 新的模板配置文件目录.

Returns:

构造器实例.

templateProfileDirOrDefault

public LocalOfficePoolManager.Builder templateProfileDirOrDefault(String templateProfileDir)

指定要复制到要创建的临时office配置文件目录的目录。如果给定的templateProfileDir无效， 则将忽略它并应用默认行为.

Parameters:

templateProfileDir - 新的模板配置文件目录.

Returns:

构造器实例.

killExistingProcess

public LocalOfficePoolManager.Builder killExistingProcess(boolean killExistingProcess)

指定在为相同连接字符串启动新office进程时是否终止现有的office进程. 默认: true

Parameters:

killExistingProcess - 当必须使用相同的连接字符串创建新进程时， true将终止现有进程，否则为false.

Returns:

构造器实例.

processTimeout

public LocalOfficePoolManager.Builder processTimeout(long processTimeout)

指定尝试执行office流程调用(启动/终止)时的超时时间，以毫秒为单位.

默认: 120000毫秒 (2分钟)

Parameters:

processTimeout - 进程超时，以毫秒为单位.

Returns:

构造器实例.

processRetryInterval

public LocalOfficePoolManager.Builder processRetryInterval(long processRetryInterval)

指定尝试执行office流程调用(开始/终止)时每次尝试之间的延迟(以毫秒为单位). 默认: 250毫秒 (0.25 秒)

Parameters:

processRetryInterval - 重试间隔，以毫秒为单位.

Returns:

构造器实例.

maxTasksPerProcess

public LocalOfficePoolManager.Builder maxTasksPerProcess(int maxTasksPerProcess)

指定office流程在重新启动之前可以执行的最大任务数.

默认: 200

Parameters:

maxTasksPerProcess - office流程可以执行的新最大任务数.

Returns:

构造器实例.

disableOpengl

public LocalOfficePoolManager.Builder disableOpengl(boolean disableOpengl)

指定在启动新office进程时是否必须禁用OpenGL. 如果OpenGL已经根据office进程使用的用户配置文件被禁用， 则不会执行任何操作。如果更改了选项，则必须重新启动office. 默认: false

Parameters:

disableOpengl - true禁用OpenGL， false禁用OpenGL.

Returns:

构造器实例.