Package com.deltaxml.docbook.config

Enum Class PreservationMode

java.lang.Object

java.lang.Enum<PreservationMode>

com.deltaxml.docbook.config.PreservationMode

All Implemented Interfaces:

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

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

An enum representing the different document preservation modes.

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	Chooses the most appropriate setting based on the output format.
DOC_AND_ATTRIB	Preserve document typing and original attribute information.
DOCUMENT	Preserve document typing information.
ENTITY_REF	Enhance round-trip processing by analysing entity contents.
NESTED_ENTITY_REF	Enhance round-trip processing by analysing both entity and nested entity contents.
ROUND_TRIP	Preserve document type, entity usage, and attribute usage data.

Method Summary

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

AUTOMATIC

public static final PreservationMode AUTOMATIC

Chooses the most appropriate setting based on the output format. If tracked changes are being produced, this will be 'roundTrip', otherwise 'docAndAttrib' will be used.

DOCUMENT

public static final PreservationMode DOCUMENT

Preserve document typing information.

DOC_AND_ATTRIB

public static final PreservationMode DOC_AND_ATTRIB

Preserve document typing and original attribute information.

ROUND_TRIP

public static final PreservationMode ROUND_TRIP

Preserve document type, entity usage, and attribute usage data.

ENTITY_REF

public static final PreservationMode ENTITY_REF

Enhance round-trip processing by analysing entity contents.

NESTED_ENTITY_REF

public static final PreservationMode NESTED_ENTITY_REF

Enhance round-trip processing by analysing both entity and nested entity contents.

Method Details

values

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

Specified by:

getDisplayName in interface com.deltaxml.docbook.DocBookCompareDisplayable

Returns:

a user-friendly String representing the PreservationMode object

getDisplayDescription

public String getDisplayDescription()

Returns the user-friendly String description of the PreservationMode.

Specified by:

getDisplayDescription in interface com.deltaxml.docbook.DocBookCompareDisplayable

Returns:

a user-friendly String description representing the PreservationMode object

toString

public String toString()

Overrides:

toString in class Enum<PreservationMode>