com.deltaxml.docbook

Enum OutputFormat

java.lang.Object

java.lang.Enum<OutputFormat>

com.deltaxml.docbook.OutputFormat

All Implemented Interfaces:

DocBookCompareDisplayable, java.io.Serializable, java.lang.Comparable<OutputFormat>

public enum OutputFormat
extends java.lang.Enum<OutputFormat>
implements DocBookCompareDisplayable

Enumeration representing the possible values for the output-format parameter

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARBORTEXT_TCS Differences are marked up in the Arbortext tracked change format.
DOCBOOK_MARKUP Differences are marked up using DocBook's revisonflag attribute.
FRAMEMAKER_TCS
OXYGEN_TCS Differences are marked up in the oXygen tracked change format.
XMETAL_TCS Differences are marked up in the XMetaL tracked change format.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayDescription() Returns the user friendly String description of the OutputFormat.
java.lang.String	getDisplayName() Returns the user friendly String name of the OutputFormat.
static OutputFormat	getOutputFormat(java.lang.String value) Returns a OutputFormat object from the supplied String value if appropriate.
static OutputFormat	parseValue(java.lang.String value) Returns a OutputFormat object from the supplied String value if appropriate.
java.lang.String	toString() Returns a String representation of OutputFormat.
static OutputFormat	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OutputFormat[]	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

DOCBOOK_MARKUP

public static final OutputFormat DOCBOOK_MARKUP

Differences are marked up using DocBook's revisonflag attribute.

ARBORTEXT_TCS

public static final OutputFormat ARBORTEXT_TCS

Differences are marked up in the Arbortext tracked change format.

OXYGEN_TCS

public static final OutputFormat OXYGEN_TCS

Differences are marked up in the oXygen tracked change format.

XMETAL_TCS

public static final OutputFormat XMETAL_TCS

Differences are marked up in the XMetaL tracked change format.

FRAMEMAKER_TCS

public static final OutputFormat FRAMEMAKER_TCS

Method Detail

values

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

Returns:

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

valueOf

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

getDisplayName

public java.lang.String getDisplayName()

Returns the user friendly String name of the OutputFormat.

Specified by:

getDisplayName in interface DocBookCompareDisplayable

Returns:

a user friendly String representing the OutputFormat object

getDisplayDescription

public java.lang.String getDisplayDescription()

Returns the user friendly String description of the OutputFormat.

Specified by:

getDisplayDescription in interface DocBookCompareDisplayable

Returns:

a user friendly String description representing the OutputFormat object

toString

public java.lang.String toString()

Returns a String representation of OutputFormat.

Overrides:

toString in class java.lang.Enum<OutputFormat>

Returns:

a String representing the OutputFormat object

getOutputFormat

public static OutputFormat getOutputFormat(java.lang.String value)

Returns a OutputFormat object from the supplied String value if appropriate.

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

Parameters:

value - a String representation of a OutputFormat value

Returns:

the OutputFormat instance corresponding to the parameter, or null if the value is invalid

parseValue

public static OutputFormat parseValue(java.lang.String value)
                               throws java.lang.IllegalArgumentException

Returns a OutputFormat object from the supplied String value if appropriate.

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

Parameters:

value - a String representation of a OutputFormat value

Returns:

the OutputFormat instance corresponding to the parameter.

Throws:

java.lang.IllegalArgumentException - Whenever the provided string does not represent one of this enum'e enumerated values.