com.groupdocs.comparison.result

Enum ComparisonAction

java.lang.Object

java.lang.Enum<ComparisonAction>

com.groupdocs.comparison.result.ComparisonAction

All Implemented Interfaces:

Serializable, Comparable<ComparisonAction>

public enum ComparisonAction
extends Enum<ComparisonAction>

The ComparisonAction enum represents the actions that can be applied to a change during the document comparison process.

Each constant in this enum represents a specific action and provides a human-readable description and a numeric value.

Example usage:

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

     final ChangeInfo[] changes = comparer.getChanges();
     for (ChangeInfo changeInfo : changes) {
         if (changeInfo.getId() % 2 == 0) {
             changeInfo.setComparisonAction(ComparisonAction.REJECT);
         }
     }
     comparer.applyChanges(resultFile, changes);
 }
 

See Also:

Comparer, ChangeInfo

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCEPT Represents an accept action.
NONE Represents no action.
REJECT Represents a reject action.

Method Summary

Modifier and Type	Method and Description
static ComparisonAction	fromInt(int intValue) Creates new constant of enum ComparisonAction using provided numeric value.
static ComparisonAction	fromString(String toStringValue) Parses string representation of ComparisonAction to get the enum constant.
int	toInt() Numeric representation of ComparisonAction.
String	toString() String representation of ComparisonAction.
static ComparisonAction	valueOf(String name) Returns the enum constant of this type with the specified name.
static ComparisonAction[]	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

ACCEPT

public static final ComparisonAction ACCEPT

Represents an accept action. The change will be visible in the result file.

NONE

public static final ComparisonAction NONE

Represents no action. The change will have no effect.

REJECT

public static final ComparisonAction REJECT

Represents a reject action. The change will be invisible in the result file.

Method Detail

fromInt

public static ComparisonAction fromInt(int intValue)

Creates new constant of enum ComparisonAction using provided numeric value.

Parameters:

intValue - The numeric representation of ComparisonAction

Returns:

ComparisonAction enum constant associated with numeric value

Throws:

IllegalArgumentException - if numeric value is not one of ComparisonAction values

fromString

public static ComparisonAction fromString(String toStringValue)

Parses string representation of ComparisonAction to get the enum constant.

Parameters:

toStringValue - The string representation of ComparisonAction

Returns:

ComparisonAction enum constant associated with input string

Throws:

IllegalArgumentException - if string is not one of ComparisonAction values

toInt

public int toInt()

Numeric representation of ComparisonAction.

Returns:

numeric value of enum constant

toString

public String toString()

String representation of ComparisonAction.

Overrides:

toString in class Enum<ComparisonAction>

Returns:

string value of enum constant

valueOf

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

Returns:

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