Package com.deltaxml.docbook.config

Enum Class KeyingMode

java.lang.Object

java.lang.Enum<KeyingMode>

com.deltaxml.docbook.config.KeyingMode

All Implemented Interfaces:

com.deltaxml.docbook.DocBookCompareDisplayable, Serializable, Comparable<KeyingMode>, Constable

public enum KeyingMode
extends Enum<KeyingMode>
implements com.deltaxml.docbook.DocBookCompareDisplayable

An enum representing the different modes to use for keying the input documents.

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
CONDITION	Use a condition attribute if present.
ID	Use an id attribute if present.
KEY_THEN_CONDITION	Use a deltaxml:key attribute if present, otherwise use a condition attribute if present.
KEY_THEN_ID	Use a deltaxml:key attribute if present, otherwise use an id attribute if present.
PRESERVE	Use existing deltaxml:key attributes from the input (and nothing else).
REMOVE	Remove all existing deltaxml:key attributes and do not add any others.

Method Summary

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

PRESERVE

public static final KeyingMode PRESERVE

Use existing deltaxml:key attributes from the input (and nothing else).

KEY_THEN_ID

public static final KeyingMode KEY_THEN_ID

Use a deltaxml:key attribute if present, otherwise use an id attribute if present.

KEY_THEN_CONDITION

public static final KeyingMode KEY_THEN_CONDITION

Use a deltaxml:key attribute if present, otherwise use a condition attribute if present.

ID

public static final KeyingMode ID

Use an id attribute if present. Otherwise, do not use a key

CONDITION

public static final KeyingMode CONDITION

Use a condition attribute if present. Otherwise, do not use a key

REMOVE

public static final KeyingMode REMOVE

Remove all existing deltaxml:key attributes and do not add any others.

Method Details

values

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

Specified by:

getDisplayName in interface com.deltaxml.docbook.DocBookCompareDisplayable

Returns:

a user-friendly String representing the KeyingMode object

getDisplayDescription

public String getDisplayDescription()

Returns the user-friendly String description of the KeyingMode.

Specified by:

getDisplayDescription in interface com.deltaxml.docbook.DocBookCompareDisplayable

Returns:

a user-friendly String description representing the KeyingMode object

toString

public String toString()

Overrides:

toString in class Enum<KeyingMode>