Package com.deltaxml.dita.config

Enum Class MapResultOrigin

java.lang.Object

java.lang.Enum<MapResultOrigin>

com.deltaxml.dita.config.MapResultOrigin

All Implemented Interfaces:

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

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

Enumeration representing which map input is being used to form the basis of the output.

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
A_DOCUMENT	The first 'A' document map is being used as the basis of the output.
B_DOCUMENT	The second 'B' document map is being used as the basis of the output.

Method Summary

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

A_DOCUMENT

public static final MapResultOrigin A_DOCUMENT

The first 'A' document map is being used as the basis of the output.

B_DOCUMENT

public static final MapResultOrigin B_DOCUMENT

The second 'B' document map is being used as the basis of the output.

Method Details

values

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

Specified by:

getDisplayName in interface com.deltaxml.dita.DitaCompareDisplayable

Returns:

a user-friendly String representing the MapResultOrigin object

getDisplayDescription

public String getDisplayDescription()

Returns the user-friendly String description of the MapResultOrigin.

Specified by:

getDisplayDescription in interface com.deltaxml.dita.DitaCompareDisplayable

Returns:

a user-friendly String description representing the MapResultOrigin object

toString

public String toString()

Returns a String representation of MapResultOrigin.

Overrides:

toString in class Enum<MapResultOrigin>

Returns:

a String representing the MapResultOrigin object