Package com.deltaxml.dita.config

Enum Class MapCopyScope

java.lang.Object

java.lang.Enum<MapCopyScope>

com.deltaxml.dita.config.MapCopyScope

All Implemented Interfaces:

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

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

Enumeration representing a DITA map's copy scope.

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
ALL	All map level references (including external scope) are copied to the output directory.
LOCAL	References with local scope are copied to the output directory.
LOCAL_AND_PEER	References with local and peer scope are copied to the output directory.

Method Summary

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

LOCAL

public static final MapCopyScope LOCAL

References with local scope are copied to the output directory.

LOCAL_AND_PEER

public static final MapCopyScope LOCAL_AND_PEER

References with local and peer scope are copied to the output directory.

ALL

public static final MapCopyScope ALL

All map level references (including external scope) are copied to the output directory.

Method Details

values

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

Specified by:

getDisplayName in interface com.deltaxml.dita.DitaCompareDisplayable

Returns:

a user-friendly String representing the MapCopyScope object

getDisplayDescription

public String getDisplayDescription()

Returns the user-friendly String description of the MapCopyScope.

Specified by:

getDisplayDescription in interface com.deltaxml.dita.DitaCompareDisplayable

Returns:

a user-friendly String description representing the MapCopyScope object

toString

public String toString()

Returns a String representation of MapCopyScope.

Overrides:

toString in class Enum<MapCopyScope>

Returns:

a String representing the MapCopyScope object