com.textkernel.tx.models.api.formatter

Enum OutputDocumentFormat

java.lang.Object

java.lang.Enum<OutputDocumentFormat>

com.textkernel.tx.models.api.formatter.OutputDocumentFormat

All Implemented Interfaces:

Serializable, Comparable<OutputDocumentFormat>

public enum OutputDocumentFormat
extends Enum<OutputDocumentFormat>

The document type to be output by the formatter endpoint

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOCX A Microsoft Word document
PDF A PDF document

Method Summary

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

DOCX

public static final OutputDocumentFormat DOCX

A Microsoft Word document

PDF

public static final OutputDocumentFormat PDF

A PDF document

Method Detail

values

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

Returns:

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

valueOf

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