org.jodconverter.office

Class ExternalOfficeManager.Builder

java.lang.Object

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

org.jodconverter.office.ExternalOfficeManager.Builder

Enclosing class:

ExternalOfficeManager

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

A builder for constructing a ExternalOfficeManager.

See Also:

ExternalOfficeManager

Field Summary

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

install, workingDir

Method Summary

Modifier and Type	Method and Description
ExternalOfficeManager	build()
ExternalOfficeManager.Builder	connectionProtocol(OfficeConnectionProtocol connectionProtocol) Specifies the connection protocol.
ExternalOfficeManager.Builder	connectOnStart(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.
ExternalOfficeManager.Builder	connectTimeout(long connectTimeout) Specifies the timeout, in milliseconds, after which a connection attempt will fail.
ExternalOfficeManager.Builder	pipeName(String pipeName) Specifies the pipe name that will be use to communicate with office.
ExternalOfficeManager.Builder	portNumber(int portNumber) Specifies the port number that will be use to communicate with office.
ExternalOfficeManager.Builder	retryInterval(long retryInterval) Specifies the delay, in milliseconds, between each try when trying to connect to office.

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

Specified by:

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

connectionProtocol

public ExternalOfficeManager.Builder connectionProtocol(OfficeConnectionProtocol connectionProtocol)

Specifies the connection protocol.

Parameters:

connectionProtocol - The new protocol to use.

Returns:

This builder instance.

pipeName

public ExternalOfficeManager.Builder pipeName(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 ExternalOfficeManager.Builder portNumber(int 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 ExternalOfficeManager.Builder connectOnStart(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: truw

Parameters:

connectOnStart - true to connect on start, false otherwise.

Returns:

This builder instance.

connectTimeout

public ExternalOfficeManager.Builder connectTimeout(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 ExternalOfficeManager.Builder retryInterval(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.