com.documents4j.job

Class LocalConverter.Builder

java.lang.Object

com.documents4j.job.LocalConverter.Builder

Enclosing class:

LocalConverter

public static final class LocalConverter.Builder
extends Object

A builder for constructing a LocalConverter.

Note: This builder is not thread safe.

Field Summary

Fields

Modifier and Type	Field and Description
protected File	baseFolder
protected int	corePoolSize
static int	DEFAULT_CORE_POOL_SIZE
static long	DEFAULT_KEEP_ALIVE_TIME
static int	DEFAULT_MAXIMUM_POOL_SIZE
static long	DEFAULT_PROCESS_TIME_OUT The default time out for external processes.
protected long	keepAliveTime
protected int	maximumPoolSize

Method Summary

Modifier and Type	Method and Description
protected static void	assertNumericArgument(long arg0, boolean arg1)
protected static void	assertNumericArgument(long arg0, boolean arg1, long arg2)
T	baseFolder(File arg0)
IConverter	build()
LocalConverter.Builder	disable(Class<? extends IExternalConverter> externalConverter) Enables the given IExternalConverter.
LocalConverter.Builder	enable(Class<? extends IExternalConverter> externalConverter) Enables the given IExternalConverter.
File	getBaseFolder()
Map<Class<? extends IExternalConverter>,Boolean>	getConverterConfiguration() Returns a map of explicitly enabled or disabled converters where the mapped value represents a boolean that indicates if a converter was enabled or disabled.
int	getCorePoolSize()
long	getKeepAliveTime()
int	getMaximumPoolSize()
long	getProcessTimeout() Returns the specified process time out in milliseconds.
protected File	normalizedBaseFolder()
LocalConverter.Builder	processTimeout(long processTimeout, TimeUnit timeUnit) Specifies a global timeout for external processes.
T	workerPool(int arg0, int arg1, long arg2, TimeUnit arg3)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PROCESS_TIME_OUT

public static final long DEFAULT_PROCESS_TIME_OUT

The default time out for external processes.

DEFAULT_CORE_POOL_SIZE

public static final int DEFAULT_CORE_POOL_SIZE

See Also:

Constant Field Values

corePoolSize

protected int corePoolSize

DEFAULT_MAXIMUM_POOL_SIZE

public static final int DEFAULT_MAXIMUM_POOL_SIZE

See Also:

Constant Field Values

maximumPoolSize

protected int maximumPoolSize

DEFAULT_KEEP_ALIVE_TIME

public static final long DEFAULT_KEEP_ALIVE_TIME

keepAliveTime

protected long keepAliveTime

baseFolder

protected File baseFolder

Method Detail

processTimeout

public LocalConverter.Builder processTimeout(long processTimeout,
                                             TimeUnit timeUnit)

Specifies a global timeout for external processes. After the specified amount of milliseconds any conversion process will be killed and the conversion will result with an error. This timeout also applies for starting up or terminating an external converter.

Parameters:

processTimeout - The process timeout.

timeUnit - The time unit of the specified process timeout.

Returns:

This builder instance.

enable

public LocalConverter.Builder enable(Class<? extends IExternalConverter> externalConverter)

Enables the given IExternalConverter. Any converter that is shipped with this library is discovered automatically from the class path and does not need to be enabled explicitly.

Parameters:

externalConverter - The converter to be enabled.

Returns:

This builder.

disable

public LocalConverter.Builder disable(Class<? extends IExternalConverter> externalConverter)

Enables the given IExternalConverter. Any converter that is shipped with this library is discovered automatically but can be disabled by invoking this method.

Parameters:

externalConverter - The converter to be disabled.

Returns:

This builder.

build

public IConverter build()

getProcessTimeout

public long getProcessTimeout()

Returns the specified process time out in milliseconds.

Returns:

The process time out in milliseconds.

getConverterConfiguration

public Map<Class<? extends IExternalConverter>,Boolean> getConverterConfiguration()

Returns a map of explicitly enabled or disabled converters where the mapped value represents a boolean that indicates if a converter was enabled or disabled.

Returns:

This builder's configuration of external converters.

assertNumericArgument

protected static void assertNumericArgument(long arg0,
                                            boolean arg1)

assertNumericArgument

protected static void assertNumericArgument(long arg0,
                                            boolean arg1,
                                            long arg2)

baseFolder

public T baseFolder(File arg0)

workerPool

public T workerPool(int arg0,
                    int arg1,
                    long arg2,
                    TimeUnit arg3)

normalizedBaseFolder

protected File normalizedBaseFolder()

getBaseFolder

public File getBaseFolder()

getCorePoolSize

public int getCorePoolSize()

getMaximumPoolSize

public int getMaximumPoolSize()

getKeepAliveTime

public long getKeepAliveTime()