com.groupdocs.comparison.words.revision

Enum RevisionType

java.lang.Object

java.lang.Enum<RevisionType>

com.groupdocs.comparison.words.revision.RevisionType

All Implemented Interfaces:

Serializable, Comparable<RevisionType>

public enum RevisionType
extends Enum<RevisionType>

Represents the types of revisions in a document.

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
DELETION Represents a type when content was removed from the document.
FORMAT_CHANGE Represents a type when change of formatting was applied to the parent node.
INSERTION Represents a type when new content was inserted in the document.
MOVING Represents a type when content was moved in the document.
STYLE_DEFINITION_CHANGE Represents a type when change of formatting was applied to the parent style.

Method Summary

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

DELETION

public static final RevisionType DELETION

Represents a type when content was removed from the document.

FORMAT_CHANGE

public static final RevisionType FORMAT_CHANGE

Represents a type when change of formatting was applied to the parent node.

INSERTION

public static final RevisionType INSERTION

Represents a type when new content was inserted in the document.

MOVING

public static final RevisionType MOVING

Represents a type when content was moved in the document.

STYLE_DEFINITION_CHANGE

public static final RevisionType STYLE_DEFINITION_CHANGE

Represents a type when change of formatting was applied to the parent style.

Method Detail

fromInt

public static RevisionType fromInt(int toIntValue)

Creates new constant of enum RevisionType using provided numeric value.

Parameters:

toIntValue - The numeric representation of RevisionType

Returns:

RevisionType enum constant associated with numeric value

Throws:

IllegalArgumentException - if numeric value is not one of RevisionType values

fromString

public static RevisionType fromString(String toStringValue)

Parses string representation of RevisionType to get the enum constant.

Parameters:

toStringValue - The string representation of RevisionType

Returns:

RevisionType enum constant associated with input string

Throws:

IllegalArgumentException - if string is not one of RevisionType values

toInt

public int toInt()

Numeric representation of RevisionType.

Returns:

numeric value of enum constant

toString

public String toString()

String representation of RevisionType.

Overrides:

toString in class Enum<RevisionType>

Returns:

string value of enum constant

valueOf

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

Returns:

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