CompareOptions Leave feedback

Inheritance: java.lang.Object

public class CompareOptions

Allows configuring the process of document comparison.

Example usage:

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

     final StyleSettings styleSettings = new StyleSettings();
     styleSettings.setHighlightColor(Color.RED);
     styleSettings.setFontColor(Color.GREEN);
     styleSettings.setUnderline(true);

     CompareOptions compareOptions = new CompareOptions();
     compareOptions.setInsertedItemStyle(styleSettings);

     comparer.compare(resultFile, compareOptions);
 }
 

public CompareOptions()

Initializes a new instance of the CompareOptions class.

public CompareOptions(StyleSettings insertedItemStyle, StyleSettings deletedItemStyle, StyleSettings changedItemStyle)

Initializes a new instance of the CompareOptions class with settings for different styles.

Parameters:

public IgnoreChangeSensitivitySettings ignoreChangeSettings

public IgnoreChangeSensitivitySettings getIgnoreChangeSettings()

Get settings to ignore changes based on similarity.

Returns: com.groupdocs.comparison.options.IgnoreChangeSensitivitySettings - Settings to ignore changes.

public void setIgnoreChangeSettings(IgnoreChangeSensitivitySettings ignoreChangeSettings)

Sets settings to ignore changes based on similarity.

Parameters:

public String getUserMasterPath()

Gets the path to the user master’s template for Diagrams.

Returns: java.lang.String - The path to the user master’s template for Diagrams.

public void setUserMasterPath(String userMasterPath)

Sets the path to the user master’s template for Diagrams.

Parameters:

public ComparisonType getComparisonType()

Gets a type of source and target documents as ComparisonType object so that Comparison will know how to compare them. When this option is set, LoadOptions.getFileType() option will be omitted.

Returns: ComparisonType - the type of source and target documents

public void setComparisonType(ComparisonType comparisonType)

Sets a type of source and target documents as ComparisonType object so that Comparison will know how to compare them. When this option is set, LoadOptions.setFileType(FileType) option will be omitted.

Parameters:

public final PaperSize getPaperSize()

Gets a size of a paper in result document as PaperSize object.

Returns: PaperSize - the size of a paper in result document

public final void setPaperSize(PaperSize value)

Sets a size of a paper in result document as PaperSize object.

Parameters:

public CalculateCoordinatesModeEnumeration getCalculateCoordinatesMode()

Gets a calculate coordinates mode as CalculateCoordinatesModeEnumeration object.

Returns: CalculateCoordinatesModeEnumeration - the calculate coordinates mode

public void setCalculateCoordinatesMode(CalculateCoordinatesModeEnumeration calculateCoordinatesMode)

Sets a calculate coordinates mode as CalculateCoordinatesModeEnumeration object.

Parameters:

public final boolean isShowDeletedContent()

Gets a flag that indicates whether to show deleted components in resultant document or not.

Returns: boolean - true if deleted components in resultant document will be shown, otherwise false

public final void setShowDeletedContent(boolean value)

Sets a flag that indicates whether to show deleted components in resultant document or not.

Parameters:

public final boolean isShowInsertedContent()

Gets a flag that indicates whether to show inserted components in resultant document or not.

Returns: boolean - true if inserted components in resultant document should be shown, otherwise false

public final void setShowInsertedContent(boolean value)

Sets a flag that indicates whether to show inserted components in resultant document or not.

Parameters:

public final boolean isGenerateSummaryPage()

Gets a flag that indicates whether to add summary page with detected changes statistics to resultant document or not.

Returns: boolean - true if summary page will be added, otherwise false

public final void setGenerateSummaryPage(boolean value)

Sets a flag that indicates whether to add summary page with detected changes statistics to resultant document or not.

Parameters:

public boolean isExtendedSummaryPage()

Gets a flag that indicates whether to add extended file comparison information to the summary page or not.

Returns: boolean - true if extended file comparison information will be added to summary page, otherwise false

public void setExtendedSummaryPage(boolean value)

Sets a flag that indicates whether to add extended file comparison information to the summary page or not.

Parameters:

public boolean isShowOnlySummaryPage()

Gets a flag that indicates whether to leave in the resulting document only a page with statistics of detected changes or not.

Returns: boolean - true if in the resulting document only a page with statistics of detected changes will be left, otherwise false

public void setShowOnlySummaryPage(boolean value)

Sets a flag that indicates whether to leave in the resulting document only a page with statistics of detected changes or not.

Parameters:

public final boolean isDetectStyleChanges()

Gets a flag that indicates whether to detect style changes or not.

Returns: boolean - true if style changes will be detected, otherwise false

public final void setDetectStyleChanges(boolean value)

Sets a flag that indicates whether to detect style changes or not.

Parameters:

public final boolean isMarkNestedContent()

Gets a flag that indicates whether to mark the children of the deleted or inserted elements as deleted or inserted.

Returns: boolean - true if the children of the deleted or inserted elements will be marked as deleted or inserted, otherwise false

public final void setMarkNestedContent(boolean value)

Sets a flag that indicates whether to mark the children of the deleted or inserted elements as deleted or inserted.

Parameters:

public final boolean isCalculateCoordinates()

Gets a flag that indicates whether to calculate coordinates for changed components.

Returns: boolean - true if coordinates for changed components will be calculated, otherwise false

public final void setCalculateCoordinates(boolean value)

Sets a flag that indicates whether to calculate coordinates for changed components.

Parameters:

public final boolean isHeaderFootersComparison()

Gets a flag that indicates whether to compare header/footer contents.

Returns: boolean - true if header/footer contents will be compared, otherwise false

public final void setHeaderFootersComparison(boolean value)

Sets a flag that indicates whether to compare header/footer contents.

Parameters:

public final DetalisationLevel getDetalisationLevel()

Gets a level of comparison detalization represented as DetalisationLevel. Default value is DetalisationLevel.LOW.

Returns: DetalisationLevel - the level of comparison detalization

public final void setDetalisationLevel(DetalisationLevel value)

Sets a level of comparison detalization represented as DetalisationLevel. Default value is DetalisationLevel.LOW

Parameters:

public final boolean isMarkChangedContent()

Gets a flag that indicates whether frames for shapes in Word Processing and for rectangles in Image documents will be used.

Returns: boolean - true if frames will be used, otherwise false

public final void setMarkChangedContent(boolean value)

Sets a flag that indicates whether frames for shapes in Word Processing and for rectangles in Image documents will be used.

Parameters:

public final StyleSettings getInsertedItemStyle()

Gets a style settings that will be applied to inserted items.

Returns: StyleSettings - style settings of inserted items

public final void setInsertedItemStyle(StyleSettings value)

Sets a style settings that will be applied to inserted items.

Parameters:

public final StyleSettings getDeletedItemStyle()

Gets a style settings that will be applied to deleted items.

Returns: StyleSettings - style settings of deleted items

public final void setDeletedItemStyle(StyleSettings value)

Sets a style settings that will be applied to deleted items.

Parameters:

public final StyleSettings getChangedItemStyle()

Gets a style settings that will be applied to changed items.

Returns: StyleSettings - style settings of changed items

public final void setChangedItemStyle(StyleSettings value)

Sets a style settings that will be applied to changed items.

Parameters:

public boolean isCompareImagesPdf()

Get a value indicating whether to compare images.

Returns: boolean - compare images

public void setCompareImagesPdf(boolean compareImagesPdf)

Set a value indicating whether to compare images.

Parameters:

public ImagesInheritance getImagesInheritanceMode()

Get a value indicating whether images inheritance mode

Returns: com.groupdocs.comparison.options.enums.ImagesInheritance - compare images

public void setImagesInheritanceMode(ImagesInheritance imagesInheritanceMode)

Set a value indicating whether to images inheritance mode.

Parameters:

public final int getSensitivityOfComparison()

Gets a sensitivity of comparison. The percentage of deleted and inserted elements of two compared objects in relation to all elements of these objects.

• If this percentage if exceeded, the object aren’t compared but are considered completely inserted and deleted.
• Min value - 0% => The comparison doesn’t occur for any length of the common subsequence of two compared object.
• Default value - 75% => Comparison occurs if the percentage of deleted and inserted elements of two compared object with respect to all elements of these objects isn’t more then 75.
• Max value - 100% => The comparison occurs at any length of the common subsequence of two compared objects.

Returns: int - the sensitivity of comparison

public final void setSensitivityOfComparison(int value)

Sets a sensitivity of comparison. The percentage of deleted and inserted elements of two compared objects in relation to all elements of these objects.

• If this percentage if exceeded, the object aren’t compared but are considered completely inserted and deleted.
• Min value - 0% => The comparison doesn’t occur for any length of the common subsequence of two compared object.
• Default value - 75% => Comparison occurs if the percentage of deleted and inserted elements of two compared object with respect to all elements of these objects isn’t more then 75.
• Max value - 100% => The comparison occurs at any length of the common subsequence of two compared objects.

Parameters:

public void setSensitivityOfComparisonForTables(Integer value)

Sets a sensitivity of comparison for tables. If the value is null, SensitivityOfComparison is used instead. The percentage of deleted and inserted elements of two compared objects in relation to all elements of these objects.

• if this percentage if exceeded, the object aren’t compared but are considered completely inserted and deleted.
• Min value - 0% => The comparison doesn’t occur for any length of the common subsequence of two compared object.
• Default value - 75% => Comparison occurs, if the percentage of deleted and inserted elements of two compared object with respect to all elements of these objects isn’t more then 75.
• Max value - 100% => The comparison occurs at any length of the common subsequence of two compared objects.

Parameters:

public final Integer getSensitivityOfComparisonForTables()

Get a sensitivity of comparison for tables. If the value is null, SensitivityOfComparison is used instead. The percentage of deleted and inserted elements of two compared objects in relation to all elements of these objects.

• if this percentage if exceeded, the object aren’t compared but are considered completely inserted and deleted.
• Min value - 0% => The comparison doesn’t occur for any length of the common subsequence of two compared object.
• Default value - 75% => Comparison occurs, if the percentage of deleted and inserted elements of two compared object with respect to all elements of these objects isn’t more then 75.
• Max value - 100% => The comparison occurs at any length of the common subsequence of two compared objects.

Returns: java.lang.Integer - The sensitivity of comparison for tables

public final void setWordsSeparatorChars(char[] value)

Sets an array of delimiters which will be used to split text into words.

Parameters:

public final PasswordSaveOption getPasswordSaveOption()

Gets a password save option represented by PasswordSaveOption object.

Returns: PasswordSaveOption - the password save option

public final void setPasswordSaveOption(PasswordSaveOption value)

Sets a password save option represented by PasswordSaveOption object.

Parameters:

public final OriginalSize getOriginalSize()

Gets an original sizes of compared documents represented by OriginalSize object.

Returns: OriginalSize - the original size of documents

public final void setOriginalSize(OriginalSize value)

Sets an original sizes of compared documents represented by OriginalSize object.

Parameters:

public final DiagramMasterSetting getDiagramMasterSetting()

Gets a setting of master page for Diagram documents represented by DiagramMasterSetting object.

Returns: DiagramMasterSetting - the diagram master page setting

public final void setDiagramMasterSetting(DiagramMasterSetting value)

Sets a setting of master page for Diagram documents represented by DiagramMasterSetting object.

Parameters:

public boolean isDirectoryCompare()

Returns a flag that indicates whether directory comparison is enabled.

Returns: boolean - true if directory comparison is enabled, otherwise false

public void setDirectoryCompare(boolean directoryCompare)

Sets a flag that indicates whether directory comparison should be enabled.

Parameters:

public boolean isShowOnlyChanged()

Returns a boolean value that indicates whether only changed items should be displayed.

Returns: boolean - true if only changed items should be displayed, otherwise false

public void setShowOnlyChanged(boolean showOnlyChanged)

Sets the value indicating whether only changed items should be displayed.

Parameters:

public FolderComparisonExtension getFolderComparisonExtension()

Gets the format of the resulting folder comparison file.

Returns: com.groupdocs.comparison.options.enums.FolderComparisonExtension - the FolderComparisonExtension representing the format of the resulting folder comparison file

public void setFolderComparisonExtension(FolderComparisonExtension folderComparisonExtension)

Sets the format of the resulting folder comparison file.

Parameters: