com.deltaxml.dita

Enum MapResultOrigin

java.lang.Object

java.lang.Enum<MapResultOrigin>

com.deltaxml.dita.MapResultOrigin

All Implemented Interfaces:

DitaCompareDisplayable, java.io.Serializable, java.lang.Comparable<MapResultOrigin>

public enum MapResultOrigin
extends java.lang.Enum<MapResultOrigin>
implements DitaCompareDisplayable

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

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
java.lang.String	getDisplayDescription() Returns the user friendly String description of the MapResultOrigin.
java.lang.String	getDisplayName() Returns the user friendly String name of the MapResultOrigin.
static MapResultOrigin	getMapResultOrigin(java.lang.String value) Returns a MapResultOrigin object from the supplied String value if appropriate.
static MapResultOrigin	parseValue(java.lang.String value) Returns a MapResultOrigin object from the supplied String value if appropriate.
java.lang.String	toString() Returns a String representation of MapResultOrigin.
static MapResultOrigin	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MapResultOrigin[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

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

Returns:

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

valueOf

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

Specified by:

getDisplayName in interface DitaCompareDisplayable

Returns:

a user friendly String representing the MapResultOrigin object

getDisplayDescription

public java.lang.String getDisplayDescription()

Returns the user friendly String description of the MapResultOrigin.

Specified by:

getDisplayDescription in interface DitaCompareDisplayable

Returns:

a user friendly String description representing the MapResultOrigin object

toString

public java.lang.String toString()

Returns a String representation of MapResultOrigin.

Overrides:

toString in class java.lang.Enum<MapResultOrigin>

Returns:

a String representing the MapResultOrigin object

getMapResultOrigin

public static MapResultOrigin getMapResultOrigin(java.lang.String value)

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

Returns:

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

parseValue

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

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

Returns:

the MapResultOrigin instance corresponding to the parameter.

Throws:

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