org.jodconverter.core.office

Class AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder<B extends AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder<B>>

java.lang.Object

org.jodconverter.core.office.AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder<B>

Enclosing class:

AbstractOfficeManagerPool<E extends AbstractOfficeManagerPoolEntry>

public abstract static class AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder<B extends AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder<B>>
extends Object

A builder for constructing an AbstractOfficeManagerPool.

See Also:

AbstractOfficeManagerPool

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	install
protected long	taskExecutionTimeout
protected long	taskQueueTimeout
protected File	workingDir

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractOfficeManagerPoolBuilder()

Method Summary

Modifier and Type	Method and Description
protected abstract @NonNull AbstractOfficeManagerPool	build() Creates the manager that is specified by this builder.
B	install() Specifies whether the office manager that will be created by this builder will then set the unique instance of the InstalledOfficeManagerHolder class.
B	taskExecutionTimeout(@Nullable Long taskExecutionTimeout) Specifies the maximum time allowed to process a task.
B	taskQueueTimeout(@Nullable Long taskQueueTimeout) Specifies the maximum living time of a task in the conversion queue.
B	workingDir(@Nullable File workingDir) Specifies the directory where temporary files and directories are created.
B	workingDir(@Nullable String workingDir) Specifies the directory where temporary files and directories are created.

Methods inherited from class java.lang.Object

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

Field Detail

install

protected boolean install

workingDir

protected File workingDir

taskExecutionTimeout

protected long taskExecutionTimeout

taskQueueTimeout

protected long taskQueueTimeout

Constructor Detail

AbstractOfficeManagerPoolBuilder

protected AbstractOfficeManagerPoolBuilder()

Method Detail

build

protected abstract @NonNull AbstractOfficeManagerPool build()

Creates the manager that is specified by this builder.

Returns:

The manager that is specified by this builder.

install

public B install()

Specifies whether the office manager that will be created by this builder will then set the unique instance of the InstalledOfficeManagerHolder class. Note that if the InstalledOfficeManagerHolder class already holds an OfficeManager instance, the owner of this existing manager is responsible to stopped it.

Default: false

Returns:

This builder instance.

workingDir

public B workingDir(@Nullable File workingDir)

Specifies the directory where temporary files and directories are created.

Default: The system temporary directory as specified by the java.io.tmpdir system property.

Parameters:

workingDir - The new working directory to set.

Returns:

This builder instance.

workingDir

public B workingDir(@Nullable String workingDir)

Specifies the directory where temporary files and directories are created.

Default: The system temporary directory as specified by the java.io.tmpdir system property.

Parameters:

workingDir - The new working directory to set.

Returns:

This builder instance.

taskExecutionTimeout

public B taskExecutionTimeout(@Nullable Long taskExecutionTimeout)

Specifies the maximum time allowed to process a task. If the processing time of a task is longer than this timeout, this task will be aborted and the next task is processed.

Default: 120000 (2 minutes)

Parameters:

taskExecutionTimeout - The task execution timeout, in milliseconds.

Returns:

This builder instance.

taskQueueTimeout

public B taskQueueTimeout(@Nullable Long taskQueueTimeout)

Specifies the maximum living time of a task in the conversion queue. The task will be removed from the queue if the waiting time is longer than this timeout.

Default: 30000 (30 seconds)

Parameters:

taskQueueTimeout - The task queue timeout, in milliseconds.

Returns:

This builder instance.