org.jodconverter.office

Enum OfficeConnectionProtocol

java.lang.Object

java.lang.Enum<OfficeConnectionProtocol>

org.jodconverter.office.OfficeConnectionProtocol

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OfficeConnectionProtocol>

public enum OfficeConnectionProtocol
extends java.lang.Enum<OfficeConnectionProtocol>

Represents protocols that can be used to communicate with a running office instance.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PIPE Represents the named pipes connection type that uses shared memory.
SOCKET Represents the connection type tha uses reliable TCP/IP socket connection.

Method Summary

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

PIPE

public static final OfficeConnectionProtocol PIPE

Represents the named pipes connection type that uses shared memory. This type of interprocess connection is marginally faster than socket connections and works only if both processes are located on the same machine. It does not work on Java by default, because Java does not support named pipes directly.

SOCKET

public static final OfficeConnectionProtocol SOCKET

Represents the connection type tha uses reliable TCP/IP socket connection.

Method Detail

values

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

Returns:

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

valueOf

public static OfficeConnectionProtocol valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null