com.deltaxml.docbook

Enum OxygenTrackChangesDeletedSpaceMode

java.lang.Object

java.lang.Enum<OxygenTrackChangesDeletedSpaceMode>

com.deltaxml.docbook.OxygenTrackChangesDeletedSpaceMode

All Implemented Interfaces:

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

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

Enumeration representing the possible values for the oxygen-tcs-deleted-space-mode parameter.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTOMATIC Chooses the delete space processing mode based on the declared oxygen-tcs-version parameter.
KEEP Keeps the original whitespace formating of the deleted region.
NORMALIZE Allows deleted text to be viewed correctly prior to oXygen 14 release.

Method Summary

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

AUTOMATIC

public static final OxygenTrackChangesDeletedSpaceMode AUTOMATIC

Chooses the delete space processing mode based on the declared oxygen-tcs-version parameter.

NORMALIZE

public static final OxygenTrackChangesDeletedSpaceMode NORMALIZE

Allows deleted text to be viewed correctly prior to oXygen 14 release.

KEEP

public static final OxygenTrackChangesDeletedSpaceMode KEEP

Keeps the original whitespace formating of the deleted region.

Method Detail

values

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

Returns:

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

valueOf

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

Specified by:

getDisplayName in interface DocBookCompareDisplayable

Returns:

a user friendly String representing the OxygenTrackChangesDeletedSpaceMode object

getDisplayDescription

public java.lang.String getDisplayDescription()

Returns the user friendly String description of the OxygenTrackChangesDeletedSpaceMode.

Specified by:

getDisplayDescription in interface DocBookCompareDisplayable

Returns:

a user friendly String description representing the OxygenTrackChangesDeletedSpaceMode object

toString

public java.lang.String toString()

Returns a String representation of OxygenTrackChangesDeletedSpaceMode.

Overrides:

toString in class java.lang.Enum<OxygenTrackChangesDeletedSpaceMode>

Returns:

a String representing the OxygenTrackChangesDeletedSpaceMode object

getOxygenTrackChangesDeletedSpaceMode

public static OxygenTrackChangesDeletedSpaceMode getOxygenTrackChangesDeletedSpaceMode(java.lang.String value)

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

Returns:

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

parseValue

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

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

Returns:

the OxygenTrackChangesDeletedSpaceMode instance corresponding to the parameter.

Throws:

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