com.groupdocs.comparison.words.revision

Class RevisionHandler

java.lang.Object

com.groupdocs.comparison.words.revision.RevisionHandler

All Implemented Interfaces:

Closeable, AutoCloseable

public class RevisionHandler
extends Object
implements Closeable

Represents a class that controls the handling of revisions.

The `RevisionHandler` class allows you to work with revisions in documents. It provides methods to retrieve the list of revisions, apply changes to revisions, and save the modified 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:

ApplyRevisionOptions, RevisionInfo, RevisionAction

Field Summary

Fields

Modifier and Type	Field and Description
static String	SOURCE_PATH_IS_NULL

Constructor Summary

Constructors

Constructor and Description
RevisionHandler(com.aspose.words.Document document) Initializes a new instance of the RevisionHandler class with a document.
RevisionHandler(InputStream file, FileType fileType) Initializes a new instance of the RevisionHandler class with a file stream containing revisions.
RevisionHandler(Path filePath) Initializes a new instance of the RevisionHandler class with the path to the file containing revisions.
RevisionHandler(String filePath) Initializes a new instance of the RevisionHandler class with the path to the file containing revisions.

Method Summary

Modifier and Type	Method and Description
void	applyRevisionChanges(ApplyRevisionOptions changes) Processes changes in revisions and applies them to the original file.
void	applyRevisionChanges(OutputStream outputStream, ApplyRevisionOptions changes) Processes changes in revisions and writes the result to the document stream.
void	applyRevisionChanges(Path filePath, ApplyRevisionOptions changes) Processes changes in revisions and writes the result to the specified file.
void	applyRevisionChanges(String filePath, ApplyRevisionOptions changes) Processes changes in revisions and writes the result to the specified file.
void	close()
List<RevisionInfo>	getRevisions() Gets the list of all revisions.

Methods inherited from class java.lang.Object

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

Field Detail

SOURCE_PATH_IS_NULL

public static final String SOURCE_PATH_IS_NULL

See Also:

Constant Field Values

Constructor Detail

RevisionHandler

public RevisionHandler(com.aspose.words.Document document)

Initializes a new instance of the RevisionHandler class with a document.

Parameters:

document - The document.

RevisionHandler

public RevisionHandler(InputStream file,
                       FileType fileType)

Initializes a new instance of the RevisionHandler class with a file stream containing revisions.

Parameters:

file - The source document stream.

fileType - The type of the file.

RevisionHandler

public RevisionHandler(Path filePath)

Initializes a new instance of the RevisionHandler class with the path to the file containing revisions.

Parameters:

filePath - The path to the file.

RevisionHandler

public RevisionHandler(String filePath)

Initializes a new instance of the RevisionHandler class with the path to the file containing revisions.

Parameters:

filePath - The path to the file.

Method Detail

applyRevisionChanges

public void applyRevisionChanges(ApplyRevisionOptions changes)

Processes changes in revisions and applies them to the original file.

Parameters:

changes - The list of changed revisions.

applyRevisionChanges

public void applyRevisionChanges(OutputStream outputStream,
                                 ApplyRevisionOptions changes)

Processes changes in revisions and writes the result to the document stream.

Parameters:

outputStream - The result document stream.

changes - The list of changed revisions.

applyRevisionChanges

public void applyRevisionChanges(Path filePath,
                                 ApplyRevisionOptions changes)

Processes changes in revisions and writes the result to the specified file.

Parameters:

filePath - The result file path.

changes - The list of changed revisions.

applyRevisionChanges

public void applyRevisionChanges(String filePath,
                                 ApplyRevisionOptions changes)

Processes changes in revisions and writes the result to the specified file.

Parameters:

filePath - The result file path.

changes - The list of changed revisions.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getRevisions

public List<RevisionInfo> getRevisions()

Gets the list of all revisions.

Due to the fact that revisions were originally sorted in a group, revisions must be taken from a List. In the List, a single revision can be split into multiple revisions with the same general text. Since the List may contain revisions with the same general text, this must be controlled when creating a list of revisions for the user. This is controlled here using List<RevisionGroup> groups.

Returns:

the list of revisions.