Package com.deltaxml.docbook.config

Enum Class WhitespaceProcessingMode

java.lang.Object

java.lang.Enum<WhitespaceProcessingMode>

com.deltaxml.docbook.config.WhitespaceProcessingMode

All Implemented Interfaces:

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

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

Enumeration representing the possible values for the whitespace-processing-mode parameter.

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 mode based on other parameter settings.
CDATA_HEURISTIC	Ignore differences in whitespace, unless they occur within a CDATA section (or are explicitly preserved).
IGNORE	Ignore differences in whitespace that is not explicitly preserved.
KEEP_A	Similar to 'ignore' except that 'A' document's whitespace is kept (instead of the 'B' document's whitespace).
NORMALIZE	Normalize whitespace in inputs before comparison.
SHOW	Display the differences in whitespace where possible.

Method Summary

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

SHOW

public static final WhitespaceProcessingMode SHOW

Display the differences in whitespace where possible.

CDATA_HEURISTIC

public static final WhitespaceProcessingMode CDATA_HEURISTIC

Ignore differences in whitespace, unless they occur within a CDATA section (or are explicitly preserved).

IGNORE

public static final WhitespaceProcessingMode IGNORE

Ignore differences in whitespace that is not explicitly preserved.

KEEP_A

public static final WhitespaceProcessingMode KEEP_A

Similar to 'ignore' except that 'A' document's whitespace is kept (instead of the 'B' document's whitespace).

NORMALIZE

public static final WhitespaceProcessingMode NORMALIZE

Normalize whitespace in inputs before comparison.

AUTOMATIC

public static final WhitespaceProcessingMode AUTOMATIC

Chooses the most appropriate mode based on other parameter settings. This is dependent on two other parameters 'output-format' and the 'preservation-mode', as discussed in the main whitespace processing mode documentation.

Method Details

values

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

Specified by:

getDisplayName in interface com.deltaxml.docbook.DocBookCompareDisplayable

Returns:

a user friendly String representing the WhitespaceProcessingMode object

getDisplayDescription

public String getDisplayDescription()

Returns the user friendly String description of the WhitespaceProcessingMode.

Specified by:

getDisplayDescription in interface com.deltaxml.docbook.DocBookCompareDisplayable

Returns:

a user friendly String description representing the WhitespaceProcessingMode object

toString

public String toString()

Overrides:

toString in class Enum<WhitespaceProcessingMode>