Package com.deltaxml.dita.config

Enum Class MapUncomparedTopicMarkup

java.lang.Object

java.lang.Enum<MapUncomparedTopicMarkup>

com.deltaxml.dita.config.MapUncomparedTopicMarkup

All Implemented Interfaces:

com.deltaxml.dita.DitaCompareDisplayable, Serializable, Comparable<MapUncomparedTopicMarkup>, Constable

public enum MapUncomparedTopicMarkup
extends Enum<MapUncomparedTopicMarkup>
implements com.deltaxml.dita.DitaCompareDisplayable

Enumeration representing what updates should be performed to uncompared/unaligned topics (in the context of a DITA map comparison).

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
AUTOMATIC	When DITA Markup is selected as the output format, behave as if 'mark-change' had been selected, otherwise behave as if 'leave-alone' had been selected.
DO_NOT_MODIFY	Do not update the uncompared topics.
MARK_CHANGE	Mark the top-level topic element of uncompared topics as added or deleted, in the manner specified by the other topic level parameters.

Method Summary

Modifier and Type	Method	Description
String	getDisplayDescription()	Returns the user-friendly String description of the MapUncomparedTopicMarkup.
String	getDisplayName()	Returns the user-friendly String name of the MapUncomparedTopicMarkup.
String	toString()	Returns a String representation of MapUncomparedTopicMarkup.
static MapUncomparedTopicMarkup	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MapUncomparedTopicMarkup[]	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

AUTOMATIC

public static final MapUncomparedTopicMarkup AUTOMATIC

When DITA Markup is selected as the output format, behave as if 'mark-change' had been selected, otherwise behave as if 'leave-alone' had been selected.

MARK_CHANGE

public static final MapUncomparedTopicMarkup MARK_CHANGE

Mark the top-level topic element of uncompared topics as added or deleted, in the manner specified by the other topic level parameters.

DO_NOT_MODIFY

public static final MapUncomparedTopicMarkup DO_NOT_MODIFY

Do not update the uncompared topics.

Method Details

values

public static MapUncomparedTopicMarkup[] 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 MapUncomparedTopicMarkup 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 MapUncomparedTopicMarkup.

Specified by:

getDisplayName in interface com.deltaxml.dita.DitaCompareDisplayable

Returns:

a user-friendly String representing the MapUncomparedTopicMarkup object

getDisplayDescription

public String getDisplayDescription()

Returns the user-friendly String description of the MapUncomparedTopicMarkup.

Specified by:

getDisplayDescription in interface com.deltaxml.dita.DitaCompareDisplayable

Returns:

a user-friendly String description representing the MapUncomparedTopicMarkup object

toString

public String toString()

Returns a String representation of MapUncomparedTopicMarkup.

Overrides:

toString in class Enum<MapUncomparedTopicMarkup>

Returns:

a String representing the MapUncomparedTopicMarkup object