com.groupdocs.comparison.options.style

Enum DetalisationLevel

java.lang.Object

java.lang.Enum<DetalisationLevel>

com.groupdocs.comparison.options.style.DetalisationLevel

All Implemented Interfaces:

Serializable, Comparable<DetalisationLevel>

public enum DetalisationLevel
extends Enum<DetalisationLevel>

Specifies the level of comparison details.

Example usage:

 try (Comparer comparer = new Comparer(sourceFile)) {
    comparer.add(targetFile);

    CompareOptions compareOptions = new CompareOptions();
    compareOptions.setDetectStyleChanges(false);
    compareOptions.setDetalisationLevel(DetalisationLevel.HIGH);

    comparer.compare(resultFile, compareOptions);
 }
 

See Also:

Comparer, CompareOptions

Enum Constant Summary

Enum Constants

Enum Constant and Description
HIGH Represents the High comparison level.
LOW Represents the Low comparison level.
MIDDLE Represents the Middle comparison level.

Method Summary

Modifier and Type	Method and Description
static DetalisationLevel	fromString(String toStringValue) Parses string representation of DetalisationLevel to get the enum constant.
String	toString() String representation of DetalisationLevel.
static DetalisationLevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static DetalisationLevel[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HIGH

public static final DetalisationLevel HIGH

Represents the High comparison level.

The "High" level is the best comparison quality, but the lowest speed. Comparison is performed per-character considering character case and spaces count.

LOW

public static final DetalisationLevel LOW

Represents the Low comparison level.

The "Low" level provides the best speed for comparisons but sacrifices comparison quality. Comparison is performed per-word.

MIDDLE

public static final DetalisationLevel MIDDLE

Represents the Middle comparison level.

The "Middle" level is a reasonable compromise between comparison speed and quality. Comparison is performed per-character, but ignoring character case and spaces count.

Method Detail

fromString

public static DetalisationLevel fromString(String toStringValue)

Parses string representation of DetalisationLevel to get the enum constant.

Parameters:

toStringValue - The string representation of DetalisationLevel

Returns:

DetalisationLevel enum constant associated with input string

Throws:

IllegalArgumentException - if string is not one of DetalisationLevel values

toString

public String toString()

String representation of DetalisationLevel.

Overrides:

toString in class Enum<DetalisationLevel>

Returns:

string value of enum constant

valueOf

public static DetalisationLevel 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

values

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

Returns:

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