org.jodconverter.local.office

Class ExternalOfficeManager.Builder

java.lang.Object

org.jodconverter.core.office.AbstractOfficeManager.AbstractOfficeManagerBuilder<ExternalOfficeManager.Builder>

org.jodconverter.local.office.ExternalOfficeManager.Builder

Enclosing class:

ExternalOfficeManager

public static final class ExternalOfficeManager.Builder
extends org.jodconverter.core.office.AbstractOfficeManager.AbstractOfficeManagerBuilder<ExternalOfficeManager.Builder>

A builder for constructing a ExternalOfficeManager.

See Also:

ExternalOfficeManager

Field Summary

Fields inherited from class org.jodconverter.core.office.AbstractOfficeManager.AbstractOfficeManagerBuilder

install, workingDir

Method Summary

Modifier and Type	Method and Description
@NonNull ExternalOfficeManager	build()
@NonNull ExternalOfficeManager.Builder	connectionProtocol(@Nullable OfficeConnectionProtocol connectionProtocol) Specifies the connection protocol.
@NonNull ExternalOfficeManager.Builder	connectOnStart(@Nullable Boolean connectOnStart) Specifies whether a connection must be attempted on OfficeManager.start()? If false, a connection will only be attempted the first time an OfficeTask is executed.
@NonNull ExternalOfficeManager.Builder	connectTimeout(@Nullable Long connectTimeout) Specifies the timeout, in milliseconds, after which a connection attempt will fail.
@NonNull ExternalOfficeManager.Builder	pipeName(@Nullable String pipeName) Specifies the pipe name that will be use to communicate with office.
@NonNull ExternalOfficeManager.Builder	portNumber(@Nullable Integer portNumber) Specifies the port number that will be use to communicate with office.
@NonNull ExternalOfficeManager.Builder	retryInterval(@Nullable Long retryInterval) Specifies the delay, in milliseconds, between each try when trying to connect to office.

Methods inherited from class org.jodconverter.core.office.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 @NonNull ExternalOfficeManager build()

Specified by:

build in class org.jodconverter.core.office.AbstractOfficeManager.AbstractOfficeManagerBuilder<ExternalOfficeManager.Builder>

connectionProtocol

public @NonNull ExternalOfficeManager.Builder connectionProtocol(@Nullable OfficeConnectionProtocol connectionProtocol)

Specifies the connection protocol.

Parameters:

connectionProtocol - The new protocol to use.

Returns:

This builder instance.

pipeName

public @NonNull ExternalOfficeManager.Builder pipeName(@Nullable String pipeName)

Specifies the pipe name that will be use to communicate with office.

Parameters:

pipeName - The pipe name to use.

Returns:

This builder instance.

portNumber

public @NonNull ExternalOfficeManager.Builder portNumber(@Nullable Integer portNumber)

Specifies the port number that will be use to communicate with office.

Parameters:

portNumber - The port number to use.

Returns:

This builder instance.

connectOnStart

public @NonNull ExternalOfficeManager.Builder connectOnStart(@Nullable Boolean connectOnStart)

Specifies whether a connection must be attempted on OfficeManager.start()? If false, a connection will only be attempted the first time an OfficeTask is executed.

Default: true

Parameters:

connectOnStart - true to connect on start, false otherwise.

Returns:

This builder instance.

connectTimeout

public @NonNull ExternalOfficeManager.Builder connectTimeout(@Nullable Long connectTimeout)

Specifies the timeout, in milliseconds, after which a connection attempt will fail.

Default: 120000 (2 minutes)

Parameters:

connectTimeout - the process timeout, in milliseconds.

Returns:

This builder instance.

retryInterval

public @NonNull ExternalOfficeManager.Builder retryInterval(@Nullable Long retryInterval)

Specifies the delay, in milliseconds, between each try when trying to connect to office.

Default: 250 (0.25 seconds)

Parameters:

retryInterval - the retry interval, in milliseconds.

Returns:

This builder instance.