com.deltaxml.cores9api.config

Enum ResultFormat

java.lang.Object

java.lang.Enum<ResultFormat>

com.deltaxml.cores9api.config.ResultFormat

All Implemented Interfaces:

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

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

Specifies the format of results output from the DocumentComparator.

Since:

7.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARBORTEXT_TC Reports changes using the Arbortext editor track changes format.
DELTA Reports changes using the DeltaXML delta file result.
FRAMEMAKER_TC Reports changes using Framemaker track changes processing instructions.
OXYGEN_TC Reports changes using oXygen Author track changes processing instructions.
XMETAL_TC Reports changes using XMetaL track changes processing instructions.

Method Summary

Modifier and Type	Method and Description
static ResultFormat	getResultFormat(java.lang.String val) Returns a ResultFormat object based on the supplied String value.
java.lang.String	toString() The camel case string form of each of the enumerated type constants.
static ResultFormat	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ResultFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DELTA

public static final ResultFormat DELTA

Reports changes using the DeltaXML delta file result.

OXYGEN_TC

public static final ResultFormat OXYGEN_TC

Reports changes using oXygen Author track changes processing instructions.

ARBORTEXT_TC

public static final ResultFormat ARBORTEXT_TC

Reports changes using the Arbortext editor track changes format.

XMETAL_TC

public static final ResultFormat XMETAL_TC

Reports changes using XMetaL track changes processing instructions.

FRAMEMAKER_TC

public static final ResultFormat FRAMEMAKER_TC

Reports changes using Framemaker track changes processing instructions.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public java.lang.String toString()

The camel case string form of each of the enumerated type constants. Here, the string for an enumeration constant of the form 'FIRST_SECOND_THIRD' is 'firstSecondThird'.

Overrides:

toString in class java.lang.Enum<ResultFormat>

Returns:

The camel case string form of each of the enumerated type constants.

getResultFormat

public static ResultFormat getResultFormat(java.lang.String val)

Returns a ResultFormat object based on the supplied String value.

This method should not be used under normal circumstances, enum instance values should be used instead.

Parameters:

val - a String representation of a ResultFormat value or null to get the default value

Returns:

the ResultFormat instance corresponding to the supplied value, or null if the value is invalid