com.deltaxml.cores9api.config

Enum ModifiedWhitespaceBehaviour

java.lang.Object

java.lang.Enum<ModifiedWhitespaceBehaviour>

com.deltaxml.cores9api.config.ModifiedWhitespaceBehaviour

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ModifiedWhitespaceBehaviour>

public enum ModifiedWhitespaceBehaviour
extends java.lang.Enum<ModifiedWhitespaceBehaviour>

Enumeration representing the possible values for handling changes in whitespace. Here, both documents must have some whitespace at a given point in order for there to be a change in whitespace. This will then be processed in accordance with the specified behaviour. Whitespace insertions and deletions are not affected by the modified whitespace behaviour.

Since:

7.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTOMATIC The context dependent automatic whitespace setting.
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 and Description
static ModifiedWhitespaceBehaviour	getModifedWhitespaceBehaviour(java.lang.String value) Returns a ModifiedWhitespaceBehaviour object from the supplied String value if appropriate.
java.lang.String	toString() Returns a String representation of ModifiedWhitespaceBehaviour.
static ModifiedWhitespaceBehaviour	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ModifiedWhitespaceBehaviour[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SHOW

public static final ModifiedWhitespaceBehaviour SHOW

Display the differences in whitespace where possible. In other words, let the whitespace changes identified by the main comparator be present in the result.

IGNORE

public static final ModifiedWhitespaceBehaviour IGNORE

Ignore differences in whitespace that is not explicitly preserved. In other words, take the 'B' document's version of any modified whitespace.

KEEP_A

public static final ModifiedWhitespaceBehaviour KEEP_A

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

NORMALIZE

public static final ModifiedWhitespaceBehaviour NORMALIZE

Normalize whitespace in inputs before comparison. In other words, remove the potential for whitespace modification, assuming user input filters do not manipulate the whitespace.

AUTOMATIC

public static final ModifiedWhitespaceBehaviour AUTOMATIC

The context dependent automatic whitespace setting. Currently this has the affect of showing whitespace changes when the ResultFormat is ResultFormat.DELTA, and ignoring whitespace change in all other contexts.

Method Detail

values

public static ModifiedWhitespaceBehaviour[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ModifiedWhitespaceBehaviour c : ModifiedWhitespaceBehaviour.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ModifiedWhitespaceBehaviour valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Returns a String representation of ModifiedWhitespaceBehaviour.

Overrides:

toString in class java.lang.Enum<ModifiedWhitespaceBehaviour>

Returns:

a String representing the ModifiedWhitespaceBehaviour object

getModifedWhitespaceBehaviour

public static ModifiedWhitespaceBehaviour getModifedWhitespaceBehaviour(java.lang.String value)

Returns a ModifiedWhitespaceBehaviour object from the supplied String value if appropriate.

This method should not be used under normal circumstances, enum instance values should be used instead.

Parameters:

value - a String representation of a ModifiedWhitespaceBehaviour value

Returns:

the ModifiedWhitespaceBehaviour instance corresponding to the parameter, or null if the value is invalid