com.topologi.diffx.config
Enum WhiteSpaceProcessing

java.lang.Object
  extended by java.lang.Enum<WhiteSpaceProcessing>
      extended by com.topologi.diffx.config.WhiteSpaceProcessing
All Implemented Interfaces:
Serializable, Comparable<WhiteSpaceProcessing>

public enum WhiteSpaceProcessing
extends Enum<WhiteSpaceProcessing>

Defines how white spaces should be processed.

White space processing can have functional implications at all stages of diffing, including when loading and formatting.

Version:
10 May 2010
Author:
Christophe Lauret

Enum Constant Summary
COMPARE
          White spaces should be preserved throughout the process and compared.
IGNORE
          All white spaces should be completely ignored, this is the most efficient processing.
PRESERVE
          White spaces should be preserved, that is they will be loaded and returned during formatting, but the algorithm can consider them equivalent and will not report differences between white spaces.
 
Method Summary
static WhiteSpaceProcessing valueOf(String name)
          Returns the enum constant of this type with the specified name.
static WhiteSpaceProcessing[] 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, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

IGNORE

public static final WhiteSpaceProcessing IGNORE
All white spaces should be completely ignored, this is the most efficient processing.


PRESERVE

public static final WhiteSpaceProcessing PRESERVE
White spaces should be preserved, that is they will be loaded and returned during formatting, but the algorithm can consider them equivalent and will not report differences between white spaces.


COMPARE

public static final WhiteSpaceProcessing COMPARE
White spaces should be preserved throughout the process and compared. All white space differences will be reported by the algorithm. This is the most costly processing.

Method Detail

values

public static WhiteSpaceProcessing[] 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 (WhiteSpaceProcessing c : WhiteSpaceProcessing.values())
    System.out.println(c);

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

valueOf

public static WhiteSpaceProcessing valueOf(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:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null