com.groupdocs.comparison.options.enums

Enum ComparisonType

java.lang.Object

java.lang.Enum<ComparisonType>

com.groupdocs.comparison.options.enums.ComparisonType

All Implemented Interfaces:

Serializable, Comparable<ComparisonType>

public enum ComparisonType
extends Enum<ComparisonType>

Represents the type of comparison to be performed.

Example usage:

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

    CompareOptions compareOptions = new CompareOptions();
    compareOptions.setComparisonType(ComparisonType.CELLS);

    comparer.compare(resultFile, compareOptions);
 }
 

See Also:

Comparer, CompareOptions

Enum Constant Summary

Enum Constants

Enum Constant and Description
CELLS Files must be compared as excel documents.
DIAGRAM Files must be compared as diagram documents.
DIFFERENT Files must be compared as documents in different formats.
EMAIL Files must be compared as email documents.
HTML Files must be compared as html documents.
IMAGING Files must be compared as image documents.
NOTE Files must be compared as note documents.
PDF Files must be compared as pdf documents.
SLIDES Files must be compared as presentation documents.
SVG Files must be compared as svg documents.
TEXT Files must be compared as text documents.
UNDEFINED For internal use.
WORDS Files must be compared as words documents.

Method Summary

Modifier and Type	Method and Description
static ComparisonType	fromString(String toStringValue) Parses string representation of ComparisonType to get the enum constant.
String	toString() String representation of ComparisonType.
static ComparisonType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ComparisonType[]	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

CELLS

public static final ComparisonType CELLS

Files must be compared as excel documents.

DIAGRAM

public static final ComparisonType DIAGRAM

Files must be compared as diagram documents.

DIFFERENT

public static final ComparisonType DIFFERENT

Files must be compared as documents in different formats.

EMAIL

public static final ComparisonType EMAIL

Files must be compared as email documents.

HTML

public static final ComparisonType HTML

Files must be compared as html documents.

IMAGING

public static final ComparisonType IMAGING

Files must be compared as image documents.

NOTE

public static final ComparisonType NOTE

Files must be compared as note documents.

PDF

public static final ComparisonType PDF

Files must be compared as pdf documents.

SLIDES

public static final ComparisonType SLIDES

Files must be compared as presentation documents.

SVG

public static final ComparisonType SVG

Files must be compared as svg documents.

TEXT

public static final ComparisonType TEXT

Files must be compared as text documents.

UNDEFINED

public static final ComparisonType UNDEFINED

For internal use.

WORDS

public static final ComparisonType WORDS

Files must be compared as words documents.

Method Detail

fromString

public static ComparisonType fromString(String toStringValue)

Parses string representation of ComparisonType to get the enum constant.

Parameters:

toStringValue - The string representation of ComparisonType

Returns:

ComparisonType enum constant associated with input string

Throws:

IllegalArgumentException - if string is not one of ComparisonType values

toString

public String toString()

String representation of ComparisonType.

Overrides:

toString in class Enum<ComparisonType>

Returns:

string value of enum constant

valueOf

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

Returns:

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