Package com.deltaxml.dita.config

Enum Class MapCleanTemp

java.lang.Object

java.lang.Enum<MapCleanTemp>

com.deltaxml.dita.config.MapCleanTemp

All Implemented Interfaces:

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

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

Enumeration representing how the result map is constructed.

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	Clean the temporary files only when the comparison is being performed on a copy of the input.
NO	Do not clean temporary files created during the map comparison.
YES	Clean temporary files created during the map comparison.

Method Summary

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

YES

public static final MapCleanTemp YES

Clean temporary files created during the map comparison.

NO

public static final MapCleanTemp NO

Do not clean temporary files created during the map comparison.

AUTOMATIC

public static final MapCleanTemp AUTOMATIC

Clean the temporary files only when the comparison is being performed on a copy of the input.

Method Details

values

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

Specified by:

getDisplayName in interface com.deltaxml.dita.DitaCompareDisplayable

Returns:

a user-friendly String representing the MapCleanTemp object

getDisplayDescription

public String getDisplayDescription()

Returns the user-friendly String description of the MapCleanTemp.

Specified by:

getDisplayDescription in interface com.deltaxml.dita.DitaCompareDisplayable

Returns:

a user-friendly String description representing the MapCleanTemp object

toString

public String toString()

Returns a String representation of MapCleanTemp.

Overrides:

toString in class Enum<MapCleanTemp>

Returns:

a String representing the MapCleanTemp object