Package com.deltaxml.dita.config

Enum Class MapTopicExceptionPropagationMode

java.lang.Object

java.lang.Enum<MapTopicExceptionPropagationMode>

com.deltaxml.dita.config.MapTopicExceptionPropagationMode

All Implemented Interfaces:

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

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

Enumeration representing what action to perform when there is an exception raised during the processing of a topic. By default, the MapTopicExceptionPropagationMode is set to SLOW_FAIL.

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
FAST_FAIL	Propagate the exception as quickly as possible to the map comparison.
PHASE_FAIL	Propagate the exception at the end of each phase of the comparison.
SLOW_FAIL	Propagate the exception once other topics and map-level operations have completed their processing.

Method Summary

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

FAST_FAIL

public static final MapTopicExceptionPropagationMode FAST_FAIL

Propagate the exception as quickly as possible to the map comparison.

PHASE_FAIL

public static final MapTopicExceptionPropagationMode PHASE_FAIL

Propagate the exception at the end of each phase of the comparison. Here, all topics are progressed to the end of the given comparison phase before the exception is thrown.

SLOW_FAIL

public static final MapTopicExceptionPropagationMode SLOW_FAIL

Propagate the exception once other topics and map-level operations have completed their processing.

Method Details

values

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

Specified by:

getDisplayName in interface com.deltaxml.dita.DitaCompareDisplayable

Returns:

a user-friendly String representing the MapTopicExceptionPropagationMode object

getDisplayDescription

public String getDisplayDescription()

Returns the user-friendly String description of the MapTopicExceptionPropagationMode.

Specified by:

getDisplayDescription in interface com.deltaxml.dita.DitaCompareDisplayable

Returns:

a user-friendly String description representing the MapTopicExceptionPropagationMode object

toString

public String toString()

Returns a String representation of MapTopicExceptionPropagationMode.

Overrides:

toString in class Enum<MapTopicExceptionPropagationMode>

Returns:

a String representing the MapTopicExceptionPropagationMode object