com.groupdocs.comparison.words.revision

Class ApplyRevisionOptions

java.lang.Object

com.groupdocs.comparison.words.revision.ApplyRevisionOptions

public class ApplyRevisionOptions
extends Object

The ApplyRevisionOptions class allows you to update the state of revisions before they are applied to the final document.

It provides various constructors and properties to customize the revision application process.

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, RevisionInfo, RevisionAction

Constructor Summary

Constructors

Constructor and Description
ApplyRevisionOptions() Initializes a new instance of the ApplyRevisionOptions class.
ApplyRevisionOptions(List<RevisionInfo> changes) Instantiates a new ApplyRevisionOptions object with the specified list of revisions.
ApplyRevisionOptions(List<RevisionInfo> changes, RevisionAction revisionAction) Instantiates a new ApplyRevisionOptions object with the specified list of revisions and a common revision action.
ApplyRevisionOptions(RevisionAction revisionAction) Instantiates a new ApplyRevisionOptions object with a common revision action.

Method Summary

Modifier and Type	Method and Description
List<RevisionInfo>	getChanges() Gets the list of revisions to be applied.
RevisionAction	getCommonHandler() Gets the common revision action to be applied to all revisions.
void	setChanges(List<RevisionInfo> changes) Sets the list of revisions to be applied.
void	setCommonHandler(RevisionAction commonHandler) Sets the common revision action to be applied to all revisions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApplyRevisionOptions

public ApplyRevisionOptions()

Initializes a new instance of the ApplyRevisionOptions class.

ApplyRevisionOptions

public ApplyRevisionOptions(List<RevisionInfo> changes)

Instantiates a new ApplyRevisionOptions object with the specified list of revisions.

Parameters:

changes - The list of revisions to be applied

ApplyRevisionOptions

public ApplyRevisionOptions(List<RevisionInfo> changes,
                            RevisionAction revisionAction)

Instantiates a new ApplyRevisionOptions object with the specified list of revisions and a common revision action.

Parameters:

changes - The list of revisions to be applied

revisionAction - The common revision action to be applied to all revisions

ApplyRevisionOptions

public ApplyRevisionOptions(RevisionAction revisionAction)

Instantiates a new ApplyRevisionOptions object with a common revision action.

Parameters:

revisionAction - The common revision action to be applied to all revisions

Method Detail

getChanges

public List<RevisionInfo> getChanges()

Gets the list of revisions to be applied.

Returns:

the list of revisions

getCommonHandler

public RevisionAction getCommonHandler()

Gets the common revision action to be applied to all revisions.

Returns:

the common revision action

setChanges

public void setChanges(List<RevisionInfo> changes)

Sets the list of revisions to be applied.

Parameters:

changes - The list of revisions

setCommonHandler

public void setCommonHandler(RevisionAction commonHandler)

Sets the common revision action to be applied to all revisions.

Parameters:

commonHandler - The common revision action