public enum MapCopyScope extends java.lang.Enum<MapCopyScope> implements DitaCompareDisplayable
Enum Constant and 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.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDisplayDescription()
Returns the user friendly String description of the MapCopyScope.
|
java.lang.String |
getDisplayName()
Returns the user friendly String name of the MapCopyScope.
|
static MapCopyScope |
getMapCopyScope(java.lang.String value)
Returns a MapCopyScope object from the supplied String value if appropriate.
|
static MapCopyScope |
parseValue(java.lang.String value)
Returns a MapCopyScope object from the supplied String value if appropriate.
|
java.lang.String |
toString()
Returns a String representation of MapCopyScope.
|
static MapCopyScope |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static MapCopyScope[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final MapCopyScope LOCAL
public static final MapCopyScope LOCAL_AND_PEER
public static final MapCopyScope ALL
public static MapCopyScope[] values()
for (MapCopyScope c : MapCopyScope.values()) System.out.println(c);
public static MapCopyScope valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic java.lang.String getDisplayName()
Returns the user friendly String name of the MapCopyScope.
getDisplayName
in interface DitaCompareDisplayable
public java.lang.String getDisplayDescription()
Returns the user friendly String description of the MapCopyScope.
getDisplayDescription
in interface DitaCompareDisplayable
public java.lang.String toString()
Returns a String representation of MapCopyScope.
toString
in class java.lang.Enum<MapCopyScope>
public static MapCopyScope getMapCopyScope(java.lang.String value)
Returns a MapCopyScope object from the supplied String value if appropriate.
This method should not be used under normal circumstances, enum instance values should be used instead.
value
- a String representation of a MapCopyScope valuepublic static MapCopyScope parseValue(java.lang.String value) throws java.lang.IllegalArgumentException
Returns a MapCopyScope object from the supplied String value if appropriate.
This method should not be used under normal circumstances, enum instance values should be used instead.
value
- a String representation of a MapCopyScope valuejava.lang.IllegalArgumentException
- Whenever the provided string does not represent one of this enum'e enumerated values.Copyright © 2001-2016 DeltaXML Ltd. All Rights Reserved.