com.groupdocs.comparison

Class Comparer

java.lang.Object

com.groupdocs.comparison.Comparer

All Implemented Interfaces:

com.aspose.ms.System.IDisposable, Closeable, AutoCloseable

public class Comparer
extends Object
implements com.aspose.ms.System.IDisposable, Closeable

The Comparer class provides functionality for comparing documents and generating comparison results.

It allows you to compare various types of documents, such as PDF, Word, Excel, PowerPoint, and more.

Example usage:

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

     CompareOptions compareOptions = new CompareOptions();
     compareOptions.setDetectStyleChanges(true);

     comparer.compare(resultFile, compareOptions);
 }
 

See Also:

CompareOptions

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILE_PATH

Constructor Summary

Constructors

Constructor and Description
Comparer(ComparerSettings settings) Initializes new instance of Comparer class with the specified ComparerSettings.
Comparer(InputStream document) Initializes new instance of Comparer class with the specified source document stream.
Comparer(InputStream document, ComparerSettings settings) Initializes new instance of Comparer class with the specified source document stream and ComparerSettings.
Comparer(InputStream document, LoadOptions loadOptions) Initializes new instance of Comparer with the specified source document stream and LoadOptions.
Comparer(InputStream document, LoadOptions loadOptions, ComparerSettings settings) Initializes new instance of Comparer class with the specified document stream, LoadOptions and ComparerSettings.
Comparer(Path filePath) Initializes new instance of Comparer class with the specified source file path.
Comparer(Path filePath, CompareOptions compareOptions) Initializes new instance of Comparer with the specified source file path and LoadOptions.
Comparer(Path filePath, ComparerSettings settings) Initializes new instance of Comparer class with the specified source file path and ComparerSettings.
Comparer(Path filePath, LoadOptions loadOptions) Initializes new instance of Comparer with the specified source file path and LoadOptions.
Comparer(Path filePath, LoadOptions loadOptions, ComparerSettings settings) Initializes new instance of Comparer class with the specified source file path, LoadOptions and ComparerSettings.
Comparer(Path filePath, LoadOptions loadOptions, ComparerSettings settings, CompareOptions compareOptions) Initializes new instance of Comparer class with the specified source file path, LoadOptions and ComparerSettings.
Comparer(String filePath) Initializes new instance of Comparer class with the specified source file path.
Comparer(String filePath, CompareOptions compareOptions) Initializes a new instance of the Comparer class with the specified folder path and compare options.
Comparer(String filePath, ComparerSettings settings) Initializes new instance of Comparer class with the specified source file path and ComparerSettings.
Comparer(String filePath, LoadOptions loadOptions) Initializes new instance of Comparer with the specified source file path and LoadOptions.
Comparer(String filePath, LoadOptions loadOptions, ComparerSettings settings) Initializes new instance of Comparer class with the specified source file path, LoadOptions and ComparerSettings.
Comparer(String filePath, LoadOptions loadOptions, ComparerSettings settings, CompareOptions compareOptions) Initializes new instance of Comparer class with the specified source file path, LoadOptions and ComparerSettings.

Method Summary

Modifier and Type	Method and Description
void	add(InputStream... documents) Adds the specified target documents to the comparison process.
void	add(InputStream document) Adds the specified target document to the comparison process.
void	add(InputStream document, LoadOptions loadOptions) Adds the specified target document to the comparison process with loading options specified.
void	add(Path... filePaths) Adds the specified target documents to the comparison process.
void	add(Path filePath) Adds the specified target document to the comparison process.
void	add(Path filePath, CompareOptions compareOptions) Adds the specified target document to the comparison process with loading options specified.
void	add(Path filePath, LoadOptions loadOptions) Adds the specified target document to the comparison process with loading options specified.
void	add(String... filePaths) Adds the specified target documents to the comparison process.
void	add(String filePath) Adds the specified target document to the comparison process.
void	add(String filePath, CompareOptions compareOptions) Adds the specified target document or folder to the comparison process.
void	add(String filePath, LoadOptions loadOptions) Adds the specified target document to the comparison process with loading options specified.
void	applyChanges(OutputStream document, ApplyChangeOptions applyChangeOptions) Accepts or rejects changes and applies them to resultant document.
void	applyChanges(OutputStream document, SaveOptions saveOptions, ApplyChangeOptions applyChangeOptions) Accepts or rejects changes and applies them to resultant document.
void	applyChanges(Path filePath, ApplyChangeOptions applyChangeOptions) Accepts or rejects changes and applies them to resultant document.
void	applyChanges(Path filePath, SaveOptions saveOptions, ApplyChangeOptions applyChangeOptions) Accepts or rejects changes and applies them to resultant document.
void	applyChanges(String filePath, ApplyChangeOptions applyChangeOptions) Accepts or rejects changes and applies them to result document.
void	applyChanges(String filePath, SaveOptions saveOptions, ApplyChangeOptions applyChangeOptions) Accepts or rejects changes and applies them to resultant document.
void	close() Releases resources.
Path	compare() Compares the specified file with the target documents without saving result with default options.
Path	compare(CompareOptions compareOptions) Compares the specified file with the target documents without saving result.
Path	compare(OutputStream outputStream) Compares the specified file with the target documents and writes a comparison result to the output stream.
Path	compare(OutputStream stream, CompareOptions compareOptions) Compares the specified file with the target documents and writes a comparison result to the output stream.
Path	compare(OutputStream stream, SaveOptions saveOptions) Compares the specified file with the target documents and writes a comparison result to the provided file path.
Path	compare(OutputStream outputStream, SaveOptions saveOptions, CompareOptions compareOptions) Compares the specified file with the target documents and writes a comparison result to the provided output stream.
Path	compare(Path filePath) Compares the specified file with the target documents and generates a comparison result.
Path	compare(Path filePath, CompareOptions compareOptions) Compares the specified file with the target documents and writes a comparison result to the provided file path.
Path	compare(Path filePath, SaveOptions saveOptions) Compares the specified file with the target documents and writes a comparison result to the provided file path.
Path	compare(Path filePath, SaveOptions saveOptions, CompareOptions compareOptions) Compares the specified file with the target documents and writes a comparison result to the provided file path.
Path	compare(SaveOptions saveOptions, CompareOptions compareOptions) Compares the specified file with the target documents without saving result.
Path	compare(String filePath) Compares the specified file with the target documents and generates a comparison result.
Path	compare(String filePath, CompareOptions compareOptions) Compares the specified file with the target documents and writes a comparison result to the provided file path.
Path	compare(String filePath, SaveOptions saveOptions) Compares the specified file with the target documents and writes a comparison result to the provided file path.
Path	compare(String filePath, SaveOptions saveOptions, CompareOptions compareOptions) Compares the specified file with the target documents and writes a comparison result to the provided file path.
void	compareDirectory(Path filePath, CompareOptions compareOptions) Compares the specified directory with the target directory and saves the comparison result to the provided file path.
void	compareDirectory(String filePath, CompareOptions compareOptions) Compares the specified directory with the target directory and saves the comparison result to the provided file path.
ChangeInfo[]	getChanges() Retrieves an array of ChangeInfo objects representing the changes detected during the comparison process.
ChangeInfo[]	getChanges(GetChangeOptions getChangeOptions) Retrieves an array of ChangeInfo objects representing the changes detected during the comparison process.
String	getResultString() Gets result string after comparison (For Text Comparison only).
Document	getSource() Gets the source document that is being compared.
String	getSourceFolder() Returns the source folder that is being compared.
String	getTargetFolder() Returns the target folder that is being compared.
List<Document>	getTargets() List of target documents to compare with source file.
static void	selfComparisonCheck(Document source, Document target) Self-comparison check (e498c23).

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aspose.ms.System.IDisposable

dispose

Field Detail

FILE_PATH

public static final String FILE_PATH

See Also:

Constant Field Values

Constructor Detail

Comparer

public Comparer(ComparerSettings settings)

Initializes new instance of Comparer class with the specified ComparerSettings.

Parameters:

settings - the settings

See Also:

ComparerSettings

Comparer

public Comparer(InputStream document)

Initializes new instance of Comparer class with the specified source document stream.

• More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
• More about GroupDocs.Comparison for Java features: Developer Guide

Parameters:

document - The input stream of the source document

Comparer

public Comparer(InputStream document,
                ComparerSettings settings)

Initializes new instance of Comparer class with the specified source document stream and ComparerSettings.

• More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
• More about GroupDocs.Comparison for Java features: Developer Guide

Parameters:

document - The input stream of the source document

settings - The comparer settings to be used for the comparison process

See Also:

ComparerSettings

Comparer

public Comparer(InputStream document,
                LoadOptions loadOptions)

Initializes new instance of Comparer with the specified source document stream and LoadOptions.

• More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
• More about GroupDocs.Comparison for Java features: Developer Guide
• More about how to open and compare password-protected documents: Open and compare password-protected documents
• More about how to open and compare document from URL, FTP, Amazon S3 and others: Open and compare documents from third-party storages

Parameters:

document - The input stream of the source document

loadOptions - The custom load options to be applied to the document

See Also:

LoadOptions

Comparer

public Comparer(InputStream document,
                LoadOptions loadOptions,
                ComparerSettings settings)

Initializes new instance of Comparer class with the specified document stream, LoadOptions and ComparerSettings.

• More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
• More about GroupDocs.Comparison for Java features: Developer Guide
• More about how to open and compare password-protected documents: Open and compare password-protected documents
• More about how to open and compare document from URL, FTP, Amazon S3 and others: Open and compare documents from third-party storages

Parameters:

document - The stream with data of a document to be compared

loadOptions - The custom load options to be applied to the document

settings - The comparer settings to be used for the comparison process

See Also:

LoadOptions, ComparerSettings

Comparer

public Comparer(Path filePath)

Initializes new instance of Comparer class with the specified source file path.

• More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
• More about GroupDocs.Comparison for Java features: Developer Guide

Parameters:

filePath - The path to the source document

Comparer

public Comparer(Path filePath,
                CompareOptions compareOptions)

Initializes new instance of Comparer with the specified source file path and LoadOptions.

• More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
• More about GroupDocs.Comparison for Java features: Developer Guide
• More about how to open and compare password-protected documents: Open and compare password-protected documents
• More about how to open and compare document from URL, FTP, Amazon S3 and others: Open and compare documents from third-party storages

Parameters:

filePath - The path to the source document

compareOptions - The compare options for folder comparison

See Also:

LoadOptions

Comparer

public Comparer(Path filePath,
                ComparerSettings settings)

Initializes new instance of Comparer class with the specified source file path and ComparerSettings.

• More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
• More about GroupDocs.Comparison for Java features: Developer Guide

Parameters:

filePath - The path to the source document

settings - The comparer settings to be used for the comparison process

See Also:

ComparerSettings

Comparer

public Comparer(Path filePath,
                LoadOptions loadOptions)

Initializes new instance of Comparer with the specified source file path and LoadOptions.

• More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
• More about GroupDocs.Comparison for Java features: Developer Guide
• More about how to open and compare password-protected documents: Open and compare password-protected documents
• More about how to open and compare document from URL, FTP, Amazon S3 and others: Open and compare documents from third-party storages

Parameters:

filePath - The path to the source document

loadOptions - The custom load options to be applied to the document

See Also:

LoadOptions

Comparer

public Comparer(Path filePath,
                LoadOptions loadOptions,
                ComparerSettings settings)

Initializes new instance of Comparer class with the specified source file path, LoadOptions and ComparerSettings.

• More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
• More about GroupDocs.Comparison for Java features: Developer Guide
• More about how to open and compare password-protected documents: Open and compare password-protected documents
• More about how to open and compare document from URL, FTP, Amazon S3 and others: Open and compare documents from third-party storages

Parameters:

filePath - The path to the source document

loadOptions - The custom load options to be applied to the document

settings - The comparer settings to be used for the comparison process

See Also:

LoadOptions, ComparerSettings

Comparer

public Comparer(Path filePath,
                LoadOptions loadOptions,
                ComparerSettings settings,
                CompareOptions compareOptions)

Initializes new instance of Comparer class with the specified source file path, LoadOptions and ComparerSettings.

• More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
• More about GroupDocs.Comparison for Java features: Developer Guide
• More about how to open and compare password-protected documents: Open and compare password-protected documents
• More about how to open and compare document from URL, FTP, Amazon S3 and others: Open and compare documents from third-party storages

Parameters:

filePath - The path to the source document or folder

loadOptions - The custom load options to be applied to the document

settings - The comparer settings to be used for the comparison process

compareOptions - The compare options for folder comparison

See Also:

LoadOptions, ComparerSettings

Comparer

public Comparer(String filePath)

Initializes new instance of Comparer class with the specified source file path.

• More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
• More about GroupDocs.Comparison for Java features: Developer Guide

Parameters:

filePath - The path to the source document

Comparer

public Comparer(String filePath,
                CompareOptions compareOptions)

Initializes a new instance of the Comparer class with the specified folder path and compare options.

• More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
• More about GroupDocs.Comparison for Java features: Developer Guide

Parameters:

filePath - The path to the source document or folder

compareOptions - The compare options for folder comparison

Comparer

public Comparer(String filePath,
                ComparerSettings settings)

Initializes new instance of Comparer class with the specified source file path and ComparerSettings.

• More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
• More about GroupDocs.Comparison for Java features: Developer Guide

Parameters:

filePath - The path to the source document

settings - The comparer settings to be used for the comparison process

See Also:

ComparerSettings

Comparer

public Comparer(String filePath,
                LoadOptions loadOptions)

Initializes new instance of Comparer with the specified source file path and LoadOptions.

• More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
• More about GroupDocs.Comparison for Java features: Developer Guide
• More about how to open and compare password-protected documents: Open and compare password-protected documents
• More about how to open and compare document from URL, FTP, Amazon S3 and others: Open and compare documents from third-party storages

Parameters:

filePath - The path to the source document

loadOptions - The custom load options to be applied to the document

See Also:

LoadOptions

Comparer

public Comparer(String filePath,
                LoadOptions loadOptions,
                ComparerSettings settings)

Initializes new instance of Comparer class with the specified source file path, LoadOptions and ComparerSettings.

• More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
• More about GroupDocs.Comparison for Java features: Developer Guide
• More about how to open and compare password-protected documents: Open and compare password-protected documents
• More about how to open and compare document from URL, FTP, Amazon S3 and others: Open and compare documents from third-party storages

Parameters:

filePath - The path to the source document

loadOptions - The custom load options to be applied to the document

settings - The comparer settings to be used for the comparison process

See Also:

LoadOptions, ComparerSettings

Comparer

public Comparer(String filePath,
                LoadOptions loadOptions,
                ComparerSettings settings,
                CompareOptions compareOptions)

Initializes new instance of Comparer class with the specified source file path, LoadOptions and ComparerSettings.

• More about file types supported by GroupDocs.Comparison: Document formats supported by GroupDocs.Comparison
• More about GroupDocs.Comparison for Java features: Developer Guide
• More about how to open and compare password-protected documents: Open and compare password-protected documents
• More about how to open and compare document from URL, FTP, Amazon S3 and others: Open and compare documents from third-party storages

Parameters:

filePath - The path to the source document or folder or text to be compared

loadOptions - The custom load options to be applied to the document

settings - The comparer settings to be used for the comparison process

compareOptions - The compare options for folder comparison

See Also:

LoadOptions, ComparerSettings

Method Detail

add

public final void add(InputStream... documents)

Adds the specified target documents to the comparison process.

Parameters:

documents - Streams with data of documents to be compared

add

public final void add(InputStream document)

Adds the specified target document to the comparison process.

• More about how to open and compare password-protected documents using GroupDocs.Comparison for Java: How to open and compare password-protected documents
• More about how to open and compare documents stored at local disk: How to open and compare files by file path
• More about how to open and compare documents from URL, FTP, Amazon S3 and other storages: How to open and compare files from third-party storages

Parameters:

document - The stream with data of a document to be compared

add

public final void add(InputStream document,
                      LoadOptions loadOptions)

Adds the specified target document to the comparison process with loading options specified.

• More about how to open and compare password-protected documents using GroupDocs.Comparison for Java: How to open and compare password-protected documents
• More about how to open and compare documents stored at local disk: How to open and compare files by file path
• More about how to open and compare documents from URL, FTP, Amazon S3 and other storages: How to open and compare files from third-party storages

Parameters:

document - The stream with data of a document to be compared

loadOptions - The custom load options to be applied to the document

See Also:

LoadOptions

add

public final void add(Path... filePaths)

Adds the specified target documents to the comparison process.

Parameters:

filePaths - Paths to the target documents to be added

add

public final void add(Path filePath)

Adds the specified target document to the comparison process.

Parameters:

filePath - The path to the target document to be added

add

public final void add(Path filePath,
                      CompareOptions compareOptions)

Adds the specified target document to the comparison process with loading options specified.

• More about how to open and compare password-protected documents using GroupDocs.Comparison for Java: How to open and compare password-protected documents
• More about how to open and compare documents stored at local disk: How to open and compare files by file path
• More about how to open and compare documents from URL, FTP, Amazon S3 and other storages: How to open and compare files from third-party storages

Parameters:

filePath - The path to the target document or folder to be added

compareOptions - The options for the comparison

See Also:

LoadOptions

add

public final void add(Path filePath,
                      LoadOptions loadOptions)

Adds the specified target document to the comparison process with loading options specified.

• More about how to open and compare password-protected documents using GroupDocs.Comparison for Java: How to open and compare password-protected documents
• More about how to open and compare documents stored at local disk: How to open and compare files by file path
• More about how to open and compare documents from URL, FTP, Amazon S3 and other storages: How to open and compare files from third-party storages

Parameters:

filePath - Path to the target document to be added

loadOptions - The custom load options to be applied to the document

See Also:

LoadOptions

add

public final void add(String... filePaths)

Adds the specified target documents to the comparison process.

Parameters:

filePaths - Paths to the target documents to be added

add

public final void add(String filePath)

Adds the specified target document to the comparison process.

Parameters:

filePath - The path to the target document to be added

add

public void add(String filePath,
                CompareOptions compareOptions)

Adds the specified target document or folder to the comparison process.

Parameters:

filePath - The path to the target document or folder to be added

compareOptions - The options for the comparison

add

public final void add(String filePath,
                      LoadOptions loadOptions)

Adds the specified target document to the comparison process with loading options specified.

• More about how to open and compare password-protected documents using GroupDocs.Comparison for Java: How to open and compare password-protected documents
• More about how to open and compare documents stored at local disk: How to open and compare files by file path
• More about how to open and compare documents from URL, FTP, Amazon S3 and other storages: How to open and compare files from third-party storages

Parameters:

filePath - Path to the target document to be added

loadOptions - The custom load options to be applied to the document

Throws:

IllegalArgumentException - if filePath is null

See Also:

LoadOptions

applyChanges

public final void applyChanges(OutputStream document,
                               ApplyChangeOptions applyChangeOptions)

Accepts or rejects changes and applies them to resultant document.

• More about how apply or reject detected differences between compared documents in a resultant document: How to apply or reject changes detected during document comparison in Java

Parameters:

document - Result document output stream

applyChangeOptions - The custom apply change options to configure process of applying changes

See Also:

ApplyChangeOptions

applyChanges

public final void applyChanges(OutputStream document,
                               SaveOptions saveOptions,
                               ApplyChangeOptions applyChangeOptions)

Accepts or rejects changes and applies them to resultant document.

• More about how apply or reject detected differences between compared documents in a resultant document: How to apply or reject changes detected during document comparison in Java

Parameters:

document - Result document output stream

saveOptions - The save options to configure saving result document

applyChangeOptions - The custom apply change options to configure process of applying changes

See Also:

SaveOptions, ApplyChangeOptions

applyChanges

public final void applyChanges(Path filePath,
                               ApplyChangeOptions applyChangeOptions)

Accepts or rejects changes and applies them to resultant document.

• More about how apply or reject detected differences between compared documents in a resultant document: How to apply or reject changes detected during document comparison in Java

Parameters:

filePath - Result document file path

applyChangeOptions - The custom apply change options to configure process of applying changes

See Also:

ApplyChangeOptions

applyChanges

public final void applyChanges(Path filePath,
                               SaveOptions saveOptions,
                               ApplyChangeOptions applyChangeOptions)

Accepts or rejects changes and applies them to resultant document.

• More about how apply or reject detected differences between compared documents in a resultant document: How to apply or reject changes detected during document comparison in Java

Parameters:

filePath - Result document file path

saveOptions - The save options to configure saving result document

applyChangeOptions - The custom apply change options to configure process of applying changes

See Also:

SaveOptions, ApplyChangeOptions

applyChanges

public final void applyChanges(String filePath,
                               ApplyChangeOptions applyChangeOptions)

Accepts or rejects changes and applies them to result document.

• More about how apply or reject detected differences between compared documents in a resultant document: How to apply or reject changes detected during document comparison in Java

Parameters:

filePath - Result document file path

applyChangeOptions - The custom apply change options to configure process of applying changes

See Also:

ApplyChangeOptions

applyChanges

public final void applyChanges(String filePath,
                               SaveOptions saveOptions,
                               ApplyChangeOptions applyChangeOptions)

Accepts or rejects changes and applies them to resultant document.

• More about how apply or reject detected differences between compared documents in a resultant document: How to apply or reject changes detected during document comparison in Java

Parameters:

filePath - Result document file path

saveOptions - The save options to configure saving result document

applyChangeOptions - The custom apply change options to configure process of applying changes

See Also:

SaveOptions, ApplyChangeOptions

close

public void close()

Releases resources.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

compare

public final Path compare()

Compares the specified file with the target documents without saving result with default options.

• More about how to compare documents: How to compare documents in Java
• More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents

Returns:

the path of result document or null

compare

public final Path compare(CompareOptions compareOptions)

Compares the specified file with the target documents without saving result.

• More about how to compare documents: How to compare documents in Java
• More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents

Parameters:

compareOptions - The compare options to be used for the comparison process

Returns:

the path to the result file or null

See Also:

CompareOptions

compare

public final Path compare(OutputStream outputStream)

Compares the specified file with the target documents and writes a comparison result to the output stream.

Note: In cases when return value is null, use data that was written into outputStream

• More about how to compare documents: How to compare documents in Java
• More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents

Parameters:

outputStream - Result document stream

Returns:

result file path or null when data from outputStream must be used. In some situations result file's extension can be changed

compare

public final Path compare(OutputStream stream,
                          CompareOptions compareOptions)

Compares the specified file with the target documents and writes a comparison result to the output stream.

Note: In case return value is null, use data that was written into outputStream.

• More about how to compare documents: How to compare documents in Java
• More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents
• More about advanced comparsion options - accepting and rejecting detected changes, adjusting comparison sensitivity etc.: Advanced comparison options guide

Parameters:

stream - Result document stream

compareOptions - The compare options to be used for the comparison process

Returns:

result file path or null when data from outputStream must be used. In some situations result file's extension can be changed

See Also:

CompareOptions

compare

public final Path compare(OutputStream stream,
                          SaveOptions saveOptions)

Compares the specified file with the target documents and writes a comparison result to the provided file path.

Note: In case return value is null, use data that was written into outputStream

• More about how to compare documents: How to compare documents in Java
• More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents

Parameters:

stream - Result document stream

saveOptions - Save options

Returns:

result file path or null when data from outputStream must be used. In some situations result file's extension can be changed

See Also:

SaveOptions

compare

public final Path compare(OutputStream outputStream,
                          SaveOptions saveOptions,
                          CompareOptions compareOptions)

Compares the specified file with the target documents and writes a comparison result to the provided output stream.

Note: In case return value is null, use data that was written into outputStream

• More about how to compare documents: How to compare documents in Java
• More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents
• More about advanced comparsion options - accepting and rejecting detected changes, adjusting comparison sensitivity etc.: Advanced comparison options guide

Parameters:

outputStream - Result document stream

saveOptions - The save options to be used for the saving the result document

compareOptions - The compare options to be used for the comparison process

Returns:

result file path or null when data from outputStream must be used. In some situations result file's extension can be changed

See Also:

SaveOptions, CompareOptions

compare

public final Path compare(Path filePath)

Compares the specified file with the target documents and generates a comparison result.

• More about how to compare documents: How to compare documents in Java
• More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents

Parameters:

filePath - Result document path

Returns:

result file path, in some situations it's extension can be changed

compare

public final Path compare(Path filePath,
                          CompareOptions compareOptions)

Compares the specified file with the target documents and writes a comparison result to the provided file path.

• More about how to compare documents: How to compare documents in Java
• More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents
• More about advanced comparsion options - accepting and rejecting detected changes, adjusting comparison sensitivity etc.: Advanced comparison options guide

Parameters:

filePath - Result document file path

compareOptions - The compare options to be used for the comparison process

Returns:

result file path, in some situations it's extension can be changed

See Also:

CompareOptions

compare

public final Path compare(Path filePath,
                          SaveOptions saveOptions)

Compares the specified file with the target documents and writes a comparison result to the provided file path.

• More about how to compare documents: How to compare documents in Java
• More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents

Parameters:

filePath - Result document file path

saveOptions - Save options

Returns:

result file path, in some situations it's extension can be changed

See Also:

SaveOptions

compare

public final Path compare(Path filePath,
                          SaveOptions saveOptions,
                          CompareOptions compareOptions)

Compares the specified file with the target documents and writes a comparison result to the provided file path.

• More about how to compare documents: How to compare documents in Java
• More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents
• More about advanced comparsion options - accepting and rejecting detected changes, adjusting comparison sensitivity etc.: Advanced comparison options guide

Parameters:

filePath - Result document file path

saveOptions - The save options to be used for the saving the result document

compareOptions - The compare options to be used for the comparison process

Returns:

result file path, in some situations it's extension can be changed

See Also:

SaveOptions, CompareOptions

compare

public final Path compare(SaveOptions saveOptions,
                          CompareOptions compareOptions)

Compares the specified file with the target documents without saving result.

• More about how to compare documents: How to compare documents in Java
• More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents
• More about advanced comparison options - accepting and rejecting detected changes, adjusting comparison sensitivity etc.: Advanced comparison options guide

Parameters:

saveOptions - Save options

compareOptions - The compare options to be used for the comparison process

Returns:

the path of the result document or null

See Also:

CompareOptions

compare

public final Path compare(String filePath)

Compares the specified file with the target documents and generates a comparison result.

• More about how to compare documents: How to compare documents in Java
• More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents

Parameters:

filePath - Result document path

Returns:

result file path or null. In some situations it's extension can be changed

compare

public final Path compare(String filePath,
                          CompareOptions compareOptions)

Compares the specified file with the target documents and writes a comparison result to the provided file path.

• More about how to compare documents: How to compare documents in Java
• More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents
• More about advanced comparsion options - accepting and rejecting detected changes, adjusting comparison sensitivity etc.: Advanced comparison options guide

Parameters:

filePath - Result document file path

compareOptions - The compare options to be used for the comparison process

Returns:

result file path, in some situations it's extension can be changed

See Also:

CompareOptions

compare

public final Path compare(String filePath,
                          SaveOptions saveOptions)

Compares the specified file with the target documents and writes a comparison result to the provided file path.

• More about how to compare documents: How to compare documents in Java
• More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents

Parameters:

filePath - Result document file path

saveOptions - Save options

Returns:

result file path, in some situations it's extension can be changed

See Also:

SaveOptions

compare

public final Path compare(String filePath,
                          SaveOptions saveOptions,
                          CompareOptions compareOptions)

Compares the specified file with the target documents and writes a comparison result to the provided file path.

• More about how to compare documents: How to compare documents in Java
• More about how to compare contracts, drafts and legal documents in Java: How to compare contracts, drafts and legal documents
• More about advanced comparison options - accepting and rejecting detected changes, adjusting comparison sensitivity etc.: Advanced comparison options guide

Parameters:

filePath - Result document file path

saveOptions - The save options to be used for the saving the result document

compareOptions - The compare options to be used for the comparison process

Returns:

result file path, in some situations it's extension can be changed

See Also:

SaveOptions, CompareOptions

compareDirectory

public void compareDirectory(Path filePath,
                             CompareOptions compareOptions)

Compares the specified directory with the target directory and saves the comparison result to the provided file path.

Parameters:

filePath - The file path where the comparison result will be saved.

compareOptions - The options to be used for the directory comparison process.

compareDirectory

public void compareDirectory(String filePath,
                             CompareOptions compareOptions)

Compares the specified directory with the target directory and saves the comparison result to the provided file path.

Parameters:

filePath - The file path where the comparison result will be saved.

compareOptions - The options to be used for the directory comparison process.

getChanges

public final ChangeInfo[] getChanges()

Retrieves an array of ChangeInfo objects representing the changes detected during the comparison process.

Use this method to get detailed information about the changes between the source document and the target document(s). Each ChangeInfo object contains information such as the type of change, the affected area, and the content before and after the change.

• More about how to obtain collection of detected differences between compared documents in Java: How to get list of changes between documents in Java
• More about how to get changes coordinates at pages image preview when comparing documents using GroupDocs.Comparison for Java: How to get changes coordinates programmatically

Returns:

an array of ChangeInfo objects representing the changes detected during the comparison process

See Also:

ChangeInfo

getChanges

public final ChangeInfo[] getChanges(GetChangeOptions getChangeOptions)

Retrieves an array of ChangeInfo objects representing the changes detected during the comparison process.

Use this method to get detailed information about the changes between the source document and the target document(s). Each ChangeInfo object contains information such as the type of change, the affected area, and the content before and after the change.

Parameter GetChangeOptions allows to filter changes in different way.

• More about how to obtain collection of detected differences between compared documents in Java: How to get list of changes between documents in Java
• More about how to get changes coordinates at pages image preview when comparing documents using GroupDocs.Comparison for Java: How to get changes coordinates programmatically

Parameters:

getChangeOptions - The object that allows to filter changes

Returns:

an array of ChangeInfo objects representing the changes detected during the comparison process

See Also:

ChangeInfo

getResultString

public String getResultString()

Gets result string after comparison (For Text Comparison only).

Returns:

the result string

getSource

public final Document getSource()

Gets the source document that is being compared.

Returns:

the source document

See Also:

Document

getSourceFolder

public String getSourceFolder()

Returns the source folder that is being compared.

Returns:

the source folder

getTargetFolder

public String getTargetFolder()

Returns the target folder that is being compared.

Returns:

the target folder

getTargets

public final List<Document> getTargets()

List of target documents to compare with source file.

Returns:

the target documents

See Also:

Document

selfComparisonCheck

public static void selfComparisonCheck(Document source,
                                       Document target)

Self-comparison check (e498c23). C# 7a7668c internal; kept public so core.common tests can call.