com.groupdocs.comparison.words.revision

Enum RevisionAction

java.lang.Object

java.lang.Enum<RevisionAction>

com.groupdocs.comparison.words.revision.RevisionAction

All Implemented Interfaces:

Serializable, Comparable<RevisionAction>

public enum RevisionAction
extends Enum<RevisionAction>

Represents an action that can be applied to a revision.

Example usage:

 try (RevisionHandler revisionHandler = new RevisionHandler(sourceFile)) {
     List<RevisionInfo> revisionList = revisionHandler.getRevisions();

     for (RevisionInfo revisionInfo : revisionList) {
         if (revisionInfo.getType() == RevisionType.DELETION)
             // Set an action to be applied to the revision
             revisionInfo.setAction(RevisionAction.Accept);
     }
     // Create an instance of ApplyRevisionOptions
     ApplyRevisionOptions revisionChanges = new ApplyRevisionOptions();
     revisionChanges.setChanges(revisionList);
     // Apply the revisions using the options
     revisionHandler.applyRevisionChanges(resultFile, revisionChanges);
 }
 

See Also:

RevisionHandler, ApplyRevisionOptions, RevisionInfo, RevisionAction

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCEPT Indicates that the revision will be displayed if it is of type INSERTION, or it will be removed if the type is DELETION.
NONE Indicates that no action is to be taken.
REJECT Indicates that the revision will be removed if it is of type INSERTION, or it will be displayed if the type is DELETION.

Method Summary

Modifier and Type	Method and Description
static RevisionAction	valueOf(String name) Returns the enum constant of this type with the specified name.
static RevisionAction[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ACCEPT

public static final RevisionAction ACCEPT

Indicates that the revision will be displayed if it is of type INSERTION, or it will be removed if the type is DELETION.

NONE

public static final RevisionAction NONE

Indicates that no action is to be taken.

REJECT

public static final RevisionAction REJECT

Indicates that the revision will be removed if it is of type INSERTION, or it will be displayed if the type is DELETION.

Method Detail

valueOf

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

Returns:

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