com.deltaxml.docbook

Enum XmetalTrackChangesTableChangeMode

java.lang.Object

java.lang.Enum<XmetalTrackChangesTableChangeMode>

com.deltaxml.docbook.XmetalTrackChangesTableChangeMode

All Implemented Interfaces:

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

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

Enumeration representing the possible values for the xmetal-tcs-table-change-mode parameter.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWN Changes in rows and cells are pushed down to the cell content level.
IGNORE All changes in a table are ignored.
UP Changes in rows and cells are pushed up to the table level.

Method Summary

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

DOWN

public static final XmetalTrackChangesTableChangeMode DOWN

Changes in rows and cells are pushed down to the cell content level.

UP

public static final XmetalTrackChangesTableChangeMode UP

Changes in rows and cells are pushed up to the table level.

IGNORE

public static final XmetalTrackChangesTableChangeMode IGNORE

All changes in a table are ignored.

Method Detail

values

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

Returns:

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

valueOf

public static XmetalTrackChangesTableChangeMode 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 XmetalTrackChangesTableChangeMode.

Specified by:

getDisplayName in interface DocBookCompareDisplayable

Returns:

a user friendly String representing the XmetalTrackChangesTableChangeMode object

getDisplayDescription

public java.lang.String getDisplayDescription()

Returns the user friendly String description of the XmetalTrackChangesTableChangeMode.

Specified by:

getDisplayDescription in interface DocBookCompareDisplayable

Returns:

a user friendly String description representing the XmetalTrackChangesTableChangeMode object

toString

public java.lang.String toString()

Returns a String representation of XmetalTrackChangesTableChangeMode.

Overrides:

toString in class java.lang.Enum<XmetalTrackChangesTableChangeMode>

Returns:

a String representing the XmetalTrackChangesTableChangeMode object

getXmetalTrackChangesTableChangeMode

public static XmetalTrackChangesTableChangeMode getXmetalTrackChangesTableChangeMode(java.lang.String value)

Returns a XmetalTrackChangesTableChangeMode 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 XmetalTrackChangesTableChangeMode value

Returns:

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

parseValue

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

Returns a XmetalTrackChangesTableChangeMode 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 XmetalTrackChangesTableChangeMode value

Returns:

the XmetalTrackChangesTableChangeMode instance corresponding to the parameter.

Throws:

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