Package com.deltaxml.docbook.config

Enum Class OutputFormat

java.lang.Object

java.lang.Enum<OutputFormat>

com.deltaxml.docbook.config.OutputFormat

All Implemented Interfaces:

com.deltaxml.docbook.DocBookCompareDisplayable, Serializable, Comparable<OutputFormat>, Constable

public enum OutputFormat
extends Enum<OutputFormat>
implements com.deltaxml.docbook.DocBookCompareDisplayable

Enumeration representing the possible values for the output-format parameter.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	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	Differences are marked up in the Framemaker tracked change format.
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	Description
String	getDisplayDescription()	Returns the user-friendly String description of the OutputFormat.
String	getDisplayName()	Returns the user-friendly String name of the OutputFormat.
String	toString()
static OutputFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OutputFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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

Differences are marked up in the Framemaker tracked change format.

Method Details

values

public static OutputFormat[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static OutputFormat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getDisplayName

public String getDisplayName()

Returns the user-friendly String name of the OutputFormat.

Specified by:

getDisplayName in interface com.deltaxml.docbook.DocBookCompareDisplayable

Returns:

a user-friendly String representing the OutputFormat object

getDisplayDescription

public String getDisplayDescription()

Returns the user-friendly String description of the OutputFormat.

Specified by:

getDisplayDescription in interface com.deltaxml.docbook.DocBookCompareDisplayable

Returns:

a user-friendly String description representing the OutputFormat object

toString

public String toString()

Overrides:

toString in class Enum<OutputFormat>