org.jodconverter.local.office

Enum ExistingProcessAction

java.lang.Object

java.lang.Enum<ExistingProcessAction>

org.jodconverter.local.office.ExistingProcessAction

All Implemented Interfaces:

Serializable, Comparable<ExistingProcessAction>

public enum ExistingProcessAction
extends Enum<ExistingProcessAction>

Represents the actions that can be taken by an LocalOfficeProcessManager when trying to start an office process with a connection string and that there already is a process running with the same connection string.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONNECT Indicates that the manager must connect to the existing office process when starting a new office process and there already is a process running with the same connection string.
CONNECT_OR_KILL Indicates that the manager must first try to connect to the existing office process when starting a new office process and there already is a process running with the same connection string.
FAIL Indicates that the LocalOfficeProcessManager must fail when trying to start an office process and there already is a process running with the same connection string.
KILL Indicates that the manager must kill the existing office process when starting a new office process and there already is a process running with the same connection string.

Method Summary

Modifier and Type	Method and Description
static ExistingProcessAction	valueOf(String name) Returns the enum constant of this type with the specified name.
static ExistingProcessAction[]	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

FAIL

public static final ExistingProcessAction FAIL

Indicates that the LocalOfficeProcessManager must fail when trying to start an office process and there already is a process running with the same connection string. If that is the case, a OfficeException is thrown.

KILL

public static final ExistingProcessAction KILL

Indicates that the manager must kill the existing office process when starting a new office process and there already is a process running with the same connection string.

CONNECT

public static final ExistingProcessAction CONNECT

Indicates that the manager must connect to the existing office process when starting a new office process and there already is a process running with the same connection string.

CONNECT_OR_KILL

public static final ExistingProcessAction CONNECT_OR_KILL

Indicates that the manager must first try to connect to the existing office process when starting a new office process and there already is a process running with the same connection string. If the connection fails, then the manager must kill the existing office process.

Method Detail

values

public static ExistingProcessAction[] 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 (ExistingProcessAction c : ExistingProcessAction.values())
    System.out.println(c);

Returns:

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

valueOf

public static ExistingProcessAction 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