org.jodconverter.local.task

Enum LoadDocumentMode

java.lang.Object

java.lang.Enum<LoadDocumentMode>

org.jodconverter.local.task.LoadDocumentMode

All Implemented Interfaces:

Serializable, Comparable<LoadDocumentMode>

public enum LoadDocumentMode
extends Enum<LoadDocumentMode>

Represents how a document is loaded/stored when converting a document.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO When using this mode, JODConverter will auto-detect which mode should be used to open a document.
LOCAL When using this mode, it is assumed that the OO instance responsible for the conversion is able to read the file from the disk, and thus the file being converted will be sent as a stream to the OO instance.
REMOTE When using this mode, the file being converted will be sent as a stream to the OO instance.

Method Summary

Modifier and Type	Method and Description
static LoadDocumentMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static LoadDocumentMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LOCAL

public static final LoadDocumentMode LOCAL

When using this mode, it is assumed that the OO instance responsible for the conversion is able to read the file from the disk, and thus the file being converted will be sent as a stream to the OO instance. This mode provides the best performance.

REMOTE

public static final LoadDocumentMode REMOTE

When using this mode, the file being converted will be sent as a stream to the OO instance. Use this mode when the OO instance responsible for the conversion is running on another server or in a docker container.

AUTO

public static final LoadDocumentMode AUTO

When using this mode, JODConverter will auto-detect which mode should be used to open a document. When the task is executed using an ExternalOfficeManager, the REMOTE mode is used. Otherwise, the LOCAL mode is used.

Method Detail

values

public static LoadDocumentMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LoadDocumentMode c : LoadDocumentMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LoadDocumentMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null