CompareOptions (GroupDocs.Total for Java (24.10) API Reference)

java.lang.Object
- com.groupdocs.comparison.options.CompareOptions

public class CompareOptions
extends Object

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);
 }

See Also:: Comparer, StyleSettings

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CompareOptions.Builder
A CompareOptions builder.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CompareOptions.Builder` A `CompareOptions` builder.

Constructor Summary

Constructors
Constructor and Description
`CompareOptions()` Initializes a new instance of the CompareOptions class.
`CompareOptions(StyleSettings insertedItemStyle, StyleSettings deletedItemStyle, StyleSettings changedItemStyle)` Initializes a new instance of the CompareOptions class with settings for different styles.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.groupdocs.comparison.options.enums.CalculateCoordinatesModeEnumeration`	`getCalculateCoordinatesMode()` Gets a calculate coordinates mode as `CalculateCoordinatesModeEnumeration` object.
`StyleSettings`	`getChangedItemStyle()` Gets a style settings that will be applied to changed items.
`ComparisonType`	`getComparisonType()` Gets a type of source and target documents as `ComparisonType` object so that Comparison will know how to compare them.
`StyleSettings`	`getDeletedItemStyle()` Gets a style settings that will be applied to deleted items.
`DetalisationLevel`	`getDetalisationLevel()` Gets a level of comparison detalization represented as `DetalisationLevel`.
`DiagramMasterSetting`	`getDiagramMasterSetting()` Gets a setting of master page for Diagram documents represented by `DiagramMasterSetting` object.
`com.groupdocs.comparison.options.enums.FolderComparisonExtension`	`getFolderComparisonExtension()` Gets the format of the resulting folder comparison file.
`StyleSettings`	`getInsertedItemStyle()` Gets a style settings that will be applied to inserted items.
`boolean`	`getMarkLineBreaks()` Get a value indicating whether to mark line breaks.
`OriginalSize`	`getOriginalSize()` Gets an original sizes of compared documents represented by `OriginalSize` object.
`PaperSize`	`getPaperSize()` Gets a size of a paper in result document as `PaperSize` object.
`PasswordSaveOption`	`getPasswordSaveOption()` Gets a password save option represented by `PasswordSaveOption` object.
`String`	`getRevisionAuthorName()` Gets or sets revision author name.
`int`	`getSensitivityOfComparison()` Gets a sensitivity of comparison.
`String`	`getUserMasterPath()` Gets the path to the user master's template for Diagrams.
`boolean`	`isCalculateCoordinates()` Gets a flag that indicates whether to calculate coordinates for changed components.
`boolean`	`isCompareBookmarks()` Gets a flag that indicates whether bookmarks in Word documents will be compared.
`boolean`	`isCompareDocumentProperty()` Gets a flag that indicates whether built and custom properties in Word documents will be compared.
`boolean`	`isCompareVariableProperty()` Gets a flag that indicates whether variables properties in Word documents will be compared.
`boolean`	`isDetectStyleChanges()` Gets a flag that indicates whether to detect style changes or not.
`boolean`	`isDirectoryCompare()` Returns a flag that indicates whether directory comparison is enabled.
`boolean`	`isExtendedSummaryPage()` Gets a flag that indicates whether to add extended file comparison information to the summary page or not.
`boolean`	`isGenerateSummaryPage()` Gets a flag that indicates whether to add summary page with detected changes statistics to resultant document or not.
`boolean`	`isHeaderFootersComparison()` Gets a flag that indicates whether to compare header/footer contents.
`boolean`	`isLeaveGaps()` Gets a flag that determines whether to leave empty lines instead of inserted/deleted components or not.
`boolean`	`isMarkChangedContent()` Gets a flag that indicates whether frames for shapes in Word Processing and for rectangles in Image documents will be used.
`boolean`	`isMarkNestedContent()` Gets a flag that indicates whether to mark the children of the deleted or inserted elements as deleted or inserted.
`boolean`	`isShowDeletedContent()` Gets a flag that indicates whether to show deleted components in resultant document or not.
`boolean`	`isShowInsertedContent()` Gets a flag that indicates whether to show inserted components in resultant document or not.
`boolean`	`isShowOnlyChanged()` Returns a boolean value that indicates whether only changed items should be displayed.
`boolean`	`isShowOnlySummaryPage()` Gets a flag that indicates whether to leave in the resulting document only a page with statistics of detected changes or not.
`boolean`	`isShowRevisions()` Gets a flag that indicates whether others revisions in the resulting document will be displayed.
`boolean`	`isWordTrackChanges()` Gets a flag that indicates whether Words Track Revisions will be compared.
`void`	`setCalculateCoordinates(boolean value)` Sets a flag that indicates whether to calculate coordinates for changed components.
`void`	`setCalculateCoordinatesMode(com.groupdocs.comparison.options.enums.CalculateCoordinatesModeEnumeration calculateCoordinatesMode)` Sets a calculate coordinates mode as `CalculateCoordinatesModeEnumeration` object.
`void`	`setChangedItemStyle(StyleSettings value)` Sets a style settings that will be applied to changed items.
`void`	`setCompareBookmarks(boolean value)` Sets a flag that indicates whether bookmarks in Word documents should be compared.
`void`	`setCompareDocumentProperty(boolean value)` Sets a flag that indicates whether built and custom properties in Word documents should be compared.
`void`	`setCompareVariableProperty(boolean value)` Sets a flag that indicates whether variables properties in Word documents should be compared.
`void`	`setComparisonType(ComparisonType comparisonType)` Sets a type of source and target documents as `ComparisonType` object so that Comparison will know how to compare them.
`void`	`setDeletedItemStyle(StyleSettings value)` Sets a style settings that will be applied to deleted items.
`void`	`setDetalisationLevel(DetalisationLevel value)` Sets a level of comparison detalization represented as `DetalisationLevel`.
`void`	`setDetectStyleChanges(boolean value)` Sets a flag that indicates whether to detect style changes or not.
`void`	`setDiagramMasterSetting(DiagramMasterSetting value)` Sets a setting of master page for Diagram documents represented by `DiagramMasterSetting` object.
`void`	`setDirectoryCompare(boolean directoryCompare)` Sets a flag that indicates whether directory comparison should be enabled.
`void`	`setExtendedSummaryPage(boolean value)` Sets a flag that indicates whether to add extended file comparison information to the summary page or not.
`void`	`setFolderComparisonExtension(com.groupdocs.comparison.options.enums.FolderComparisonExtension folderComparisonExtension)` Sets the format of the resulting folder comparison file.
`void`	`setGenerateSummaryPage(boolean value)` Sets a flag that indicates whether to add summary page with detected changes statistics to resultant document or not.
`void`	`setHeaderFootersComparison(boolean value)` Sets a flag that indicates whether to compare header/footer contents.
`void`	`setInsertedItemStyle(StyleSettings value)` Sets a style settings that will be applied to inserted items.
`void`	`setLeaveGaps(boolean value)` Sets a flag that determines whether to leave empty lines instead of inserted/deleted components or not.
`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.
`void`	`setMarkLineBreaks(boolean value)` Set a value indicating whether to mark line breaks.
`void`	`setMarkNestedContent(boolean value)` Sets a flag that indicates whether to mark the children of the deleted or inserted elements as deleted or inserted.
`void`	`setOriginalSize(OriginalSize value)` Sets an original sizes of compared documents represented by `OriginalSize` object.
`void`	`setPaperSize(PaperSize value)` Sets a size of a paper in result document as `PaperSize` object.
`void`	`setPasswordSaveOption(PasswordSaveOption value)` Sets a password save option represented by `PasswordSaveOption` object.
`void`	`setRevisionAuthorName(String revisionAuthorName)` Sets the revision author name.
`void`	`setSensitivityOfComparison(int value)` Sets a sensitivity of comparison.
`void`	`setShowDeletedContent(boolean value)` Sets a flag that indicates whether to show deleted components in resultant document or not.
`void`	`setShowInsertedContent(boolean value)` Sets a flag that indicates whether to show inserted components in resultant document or not.
`void`	`setShowOnlyChanged(boolean showOnlyChanged)` Sets the value indicating whether only changed items should be displayed.
`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.
`void`	`setShowRevisions(boolean value)` Sets a flag that indicates whether others revisions in the resulting document should be displayed.
`void`	`setUserMasterPath(String userMasterPath)` Sets the path to the user master's template for Diagrams.
`void`	`setWordsSeparatorChars(char[] value)` Sets an array of delimiters which will be used to split text into words.
`void`	`setWordTrackChanges(boolean value)` Sets a flag that indicates whether Words Track Revisions should be compared.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CompareOptions
```
public CompareOptions()
```
    Initializes a new instance of the CompareOptions class.
  - CompareOptions
```
public CompareOptions(StyleSettings insertedItemStyle,
                      StyleSettings deletedItemStyle,
                      StyleSettings changedItemStyle)
```
    Initializes a new instance of the CompareOptions class with settings for different styles.
    
    Parameters:
    
    insertedItemStyle - Style settings for inserted items
    
    deletedItemStyle - Style settings for deleted items
    
    changedItemStyle - Style settings for changed style items
- Method Detail
  - getCalculateCoordinatesMode
```
public com.groupdocs.comparison.options.enums.CalculateCoordinatesModeEnumeration getCalculateCoordinatesMode()
```
    Gets a calculate coordinates mode as CalculateCoordinatesModeEnumeration object.
    
    Returns:
    
    the calculate coordinates mode
  - getChangedItemStyle
```
public final StyleSettings getChangedItemStyle()
```
    Gets a style settings that will be applied to changed items.
    
    Returns:
    
    style settings of changed items
  - getComparisonType
```
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:
    
    the type of source and target documents
  - getDeletedItemStyle
```
public final StyleSettings getDeletedItemStyle()
```
    Gets a style settings that will be applied to deleted items.
    
    Returns:
    
    style settings of deleted items
  - getDetalisationLevel
```
public final DetalisationLevel getDetalisationLevel()
```
    Gets a level of comparison detalization represented as DetalisationLevel.
    Default value is DetalisationLevel.LOW.
    
    Returns:
    
    the level of comparison detalization
  - getDiagramMasterSetting
```
public final DiagramMasterSetting getDiagramMasterSetting()
```
    Gets a setting of master page for Diagram documents represented by DiagramMasterSetting object.
    
    Returns:
    
    the diagram master page setting
  - getFolderComparisonExtension
```
public com.groupdocs.comparison.options.enums.FolderComparisonExtension getFolderComparisonExtension()
```
    Gets the format of the resulting folder comparison file.
    
    Returns:
    
    the FolderComparisonExtension representing the format of the resulting folder comparison file
  - getInsertedItemStyle
```
public final StyleSettings getInsertedItemStyle()
```
    Gets a style settings that will be applied to inserted items.
    
    Returns:
    
    style settings of inserted items
  - getMarkLineBreaks
```
public final boolean getMarkLineBreaks()
```
    Get a value indicating whether to mark line breaks.
    
    Returns:
    
    style settings of changed items
  - getOriginalSize
```
public final OriginalSize getOriginalSize()
```
    Gets an original sizes of compared documents represented by OriginalSize object.
    
    Returns:
    
    the original size of documents
  - getPaperSize
```
public final PaperSize getPaperSize()
```
    Gets a size of a paper in result document as PaperSize object.
    
    Returns:
    
    the size of a paper in result document
  - getPasswordSaveOption
```
public final PasswordSaveOption getPasswordSaveOption()
```
    Gets a password save option represented by PasswordSaveOption object.
    
    Returns:
    
    the password save option
  - getRevisionAuthorName
```
public String getRevisionAuthorName()
```
    Gets or sets revision author name. Enabled if not null.
    
    Returns:
    
    The revision author name.
  - getSensitivityOfComparison
```
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:
    
    the sensitivity of comparison
  - getUserMasterPath
```
public String getUserMasterPath()
```
    Gets the path to the user master's template for Diagrams.
    
    Returns:
    
    The path to the user master's template for Diagrams.
  - isCalculateCoordinates
```
public final boolean isCalculateCoordinates()
```
    Gets a flag that indicates whether to calculate coordinates for changed components.
    
    Returns:
    
    true if coordinates for changed components will be calculated, otherwise false
  - isCompareBookmarks
```
public boolean isCompareBookmarks()
```
    Gets a flag that indicates whether bookmarks in Word documents will be compared.
    
    Returns:
    
    true if bookmarks in Word documents will be compared, otherwise false
  - isCompareDocumentProperty
```
public boolean isCompareDocumentProperty()
```
    Gets a flag that indicates whether built and custom properties in Word documents will be compared.
    
    Returns:
    
    true if built and custom properties in Word documents will be compared, otherwise false
  - isCompareVariableProperty
```
public boolean isCompareVariableProperty()
```
    Gets a flag that indicates whether variables properties in Word documents will be compared.
    
    Returns:
    
    true if variables properties in Word documents will be compared, otherwise false
  - isDetectStyleChanges
```
public final boolean isDetectStyleChanges()
```
    Gets a flag that indicates whether to detect style changes or not.
    
    Returns:
    
    true if style changes will be detected, otherwise false
  - isDirectoryCompare
```
public boolean isDirectoryCompare()
```
    Returns a flag that indicates whether directory comparison is enabled.
    
    Returns:
    
    true if directory comparison is enabled, otherwise false
  - isExtendedSummaryPage
```
public boolean isExtendedSummaryPage()
```
    Gets a flag that indicates whether to add extended file comparison information to the summary page or not.
    
    Returns:
    
    true if extended file comparison information will be added to summary page, otherwise false
  - isGenerateSummaryPage
```
public final boolean isGenerateSummaryPage()
```
    Gets a flag that indicates whether to add summary page with detected changes statistics to resultant document or not.
    
    Returns:
    
    true if summary page will be added, otherwise false
  - isHeaderFootersComparison
```
public final boolean isHeaderFootersComparison()
```
    Gets a flag that indicates whether to compare header/footer contents.
    
    Returns:
    
    true if header/footer contents will be compared, otherwise false
  - isLeaveGaps
```
public boolean isLeaveGaps()
```
    Gets a flag that determines whether to leave empty lines instead of inserted/deleted components or not.
    Whether to display empty lines instead of inserted/deleted components in the final document or not. Used with isShowInsertedContent() or isShowDeletedContent() properties.
    
    Returns:
    
    true if empty lines should be displayed instead of inserted/deleted components, otherwise false
  - isMarkChangedContent
```
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:
    
    true if frames will be used, otherwise false
  - isMarkNestedContent
```
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:
    
    true if the children of the deleted or inserted elements will be marked as deleted or inserted, otherwise false
  - isShowDeletedContent
```
public final boolean isShowDeletedContent()
```
    Gets a flag that indicates whether to show deleted components in resultant document or not.
    
    Returns:
    
    true if deleted components in resultant document will be shown, otherwise false
  - isShowInsertedContent
```
public final boolean isShowInsertedContent()
```
    Gets a flag that indicates whether to show inserted components in resultant document or not.
    
    Returns:
    
    true if inserted components in resultant document should be shown, otherwise false
  - isShowOnlyChanged
```
public boolean isShowOnlyChanged()
```
    Returns a boolean value that indicates whether only changed items should be displayed.
    
    Returns:
    
    true if only changed items should be displayed, otherwise false
  - isShowOnlySummaryPage
```
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:
    
    true if in the resulting document only a page with statistics of detected changes will be left, otherwise false
  - isShowRevisions
```
public boolean isShowRevisions()
```
    Gets a flag that indicates whether others revisions in the resulting document will be displayed.
    
    Returns:
    
    value true if others revisions in the resulting document will be displayed, otherwise false
  - isWordTrackChanges
```
public boolean isWordTrackChanges()
```
    Gets a flag that indicates whether Words Track Revisions will be compared.
    
    Returns:
    
    true if Words Track Revisions will be compared, otherwise false
  - setCalculateCoordinates
```
public final void setCalculateCoordinates(boolean value)
```
    Sets a flag that indicates whether to calculate coordinates for changed components.
    
    Parameters:
    
    value - true if coordinates for changed components should be calculated, otherwise false
  - setCalculateCoordinatesMode
```
public void setCalculateCoordinatesMode(com.groupdocs.comparison.options.enums.CalculateCoordinatesModeEnumeration calculateCoordinatesMode)
```
    Sets a calculate coordinates mode as CalculateCoordinatesModeEnumeration object.
    
    Parameters:
    
    calculateCoordinatesMode - The calculate coordinates mode
  - setChangedItemStyle
```
public final void setChangedItemStyle(StyleSettings value)
```
    Sets a style settings that will be applied to changed items.
    
    Parameters:
    
    value - Style settings of changed items
    
    Throws:
    
    IllegalArgumentException - if value is null
  - setCompareBookmarks
```
public void setCompareBookmarks(boolean value)
```
    Sets a flag that indicates whether bookmarks in Word documents should be compared.
    
    Parameters:
    
    value - true if bookmarks in Word documents should be compared, otherwise false
  - setCompareDocumentProperty
```
public void setCompareDocumentProperty(boolean value)
```
    Sets a flag that indicates whether built and custom properties in Word documents should be compared.
    
    Parameters:
    
    value - true if built and custom properties in Word documents should be compared, otherwise false
  - setCompareVariableProperty
```
public void setCompareVariableProperty(boolean value)
```
    Sets a flag that indicates whether variables properties in Word documents should be compared.
    
    Parameters:
    
    value - true if variables properties in Word documents should be compared, otherwise false
  - setComparisonType
```
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:
    
    comparisonType - The type of source and target documents
  - setDeletedItemStyle
```
public final void setDeletedItemStyle(StyleSettings value)
```
    Sets a style settings that will be applied to deleted items.
    
    Parameters:
    
    value - Style settings of deleted items
    
    Throws:
    
    IllegalArgumentException - if value is null
  - setDetalisationLevel
```
public final void setDetalisationLevel(DetalisationLevel value)
```
    Sets a level of comparison detalization represented as DetalisationLevel.
    Default value is DetalisationLevel.LOW
    
    Parameters:
    
    value - The level of comparison detalization
    
    Throws:
    
    IllegalArgumentException - if value is null
  - setDetectStyleChanges
```
public final void setDetectStyleChanges(boolean value)
```
    Sets a flag that indicates whether to detect style changes or not.
    
    Parameters:
    
    value - true if style changes should be detected, otherwise false
  - setDiagramMasterSetting
```
public final void setDiagramMasterSetting(DiagramMasterSetting value)
```
    Sets a setting of master page for Diagram documents represented by DiagramMasterSetting object.
    
    Parameters:
    
    value - The diagram master page setting
    
    Throws:
    
    IllegalArgumentException - if value is null
  - setDirectoryCompare
```
public void setDirectoryCompare(boolean directoryCompare)
```
    Sets a flag that indicates whether directory comparison should be enabled.
    
    Parameters:
    
    directoryCompare - true if directory comparison should be enabled, otherwise false
  - setExtendedSummaryPage
```
public void setExtendedSummaryPage(boolean value)
```
    Sets a flag that indicates whether to add extended file comparison information to the summary page or not.
    
    Parameters:
    
    value - true if extended file comparison information should be added to summary page, otherwise false
  - setFolderComparisonExtension
```
public void setFolderComparisonExtension(com.groupdocs.comparison.options.enums.FolderComparisonExtension folderComparisonExtension)
```
    Sets the format of the resulting folder comparison file.
    
    Parameters:
    
    folderComparisonExtension - the FolderComparisonExtension representing the format of the resulting folder comparison file
  - setGenerateSummaryPage
```
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:
    
    value - true if summary page should be added, otherwise false
  - setHeaderFootersComparison
```
public final void setHeaderFootersComparison(boolean value)
```
    Sets a flag that indicates whether to compare header/footer contents.
    
    Parameters:
    
    value - true if header/footer contents should be compared, otherwise false
  - setInsertedItemStyle
```
public final void setInsertedItemStyle(StyleSettings value)
```
    Sets a style settings that will be applied to inserted items.
    
    Parameters:
    
    value - Style settings of inserted items
    
    Throws:
    
    IllegalArgumentException - if value is null
  - setLeaveGaps
```
public void setLeaveGaps(boolean value)
```
    Sets a flag that determines whether to leave empty lines instead of inserted/deleted components or not.
    Whether to display empty lines instead of inserted/deleted components in the final document or not. Used with isShowInsertedContent() or isShowDeletedContent() properties.
    
    Parameters:
    
    value - true if empty lines should be displayed instead of inserted/deleted components, otherwise false
  - setMarkChangedContent
```
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:
    
    value - true if frames should be used, otherwise false
  - setMarkLineBreaks
```
public final void setMarkLineBreaks(boolean value)
```
    Set a value indicating whether to mark line breaks.
    
    Parameters:
    
    value - Style settings of changed items
    
    Throws:
    
    IllegalArgumentException - if value is null
  - setMarkNestedContent
```
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:
    
    value - true if the children of the deleted or inserted elements should be marked as deleted or inserted, otherwise false
  - setOriginalSize
```
public final void setOriginalSize(OriginalSize value)
```
    Sets an original sizes of compared documents represented by OriginalSize object.
    
    Parameters:
    
    value - The original size of documents
    
    Throws:
    
    IllegalArgumentException - if value is null
  - setPaperSize
```
public final void setPaperSize(PaperSize value)
```
    Sets a size of a paper in result document as PaperSize object.
    
    Parameters:
    
    value - The size of a paper in result document
  - setPasswordSaveOption
```
public final void setPasswordSaveOption(PasswordSaveOption value)
```
    Sets a password save option represented by PasswordSaveOption object.
    
    Parameters:
    
    value - The password save option
    
    Throws:
    
    IllegalArgumentException - if value is null
  - setRevisionAuthorName
```
public void setRevisionAuthorName(String revisionAuthorName)
```
    Sets the revision author name. Enabled if not null.
    
    Parameters:
    
    revisionAuthorName - The new revision author name to be set.
  - setSensitivityOfComparison
```
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:
    
    value - The sensitivity of comparison
  - setShowDeletedContent
```
public final void setShowDeletedContent(boolean value)
```
    Sets a flag that indicates whether to show deleted components in resultant document or not.
    
    Parameters:
    
    value - true if deleted components in resultant document should be shown, otherwise false
  - setShowInsertedContent
```
public final void setShowInsertedContent(boolean value)
```
    Sets a flag that indicates whether to show inserted components in resultant document or not.
    
    Parameters:
    
    value - true if inserted components in resultant document should be shown, otherwise false
  - setShowOnlyChanged
```
public void setShowOnlyChanged(boolean showOnlyChanged)
```
    Sets the value indicating whether only changed items should be displayed.
    
    Parameters:
    
    showOnlyChanged - the boolean value indicating whether only changed items should be displayed
  - setShowOnlySummaryPage
```
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:
    
    value - true if in the resulting document only a page with statistics of detected changes should be left, otherwise false
  - setShowRevisions
```
public void setShowRevisions(boolean value)
```
    Sets a flag that indicates whether others revisions in the resulting document should be displayed.
    
    Parameters:
    
    value - true if others revisions in the resulting document should be displayed, otherwise false
  - setUserMasterPath
```
public void setUserMasterPath(String userMasterPath)
```
    Sets the path to the user master's template for Diagrams.
    
    Parameters:
    
    userMasterPath - The path to the user master's template for Diagrams.
  - setWordsSeparatorChars
```
public final void setWordsSeparatorChars(char[] value)
```
    Sets an array of delimiters which will be used to split text into words.
    
    Parameters:
    
    value - The array of delimiters to split text into words
    
    Throws:
    
    IllegalArgumentException - if value is null
  - setWordTrackChanges
```
public void setWordTrackChanges(boolean value)
```
    Sets a flag that indicates whether Words Track Revisions should be compared.
    
    Parameters:
    
    value - true if Words Track Revisions should be compared, otherwise false

Class CompareOptions

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CompareOptions

CompareOptions

Method Detail

getCalculateCoordinatesMode

getChangedItemStyle

getComparisonType

getDeletedItemStyle

getDetalisationLevel

getDiagramMasterSetting

getFolderComparisonExtension

getInsertedItemStyle

getMarkLineBreaks

getOriginalSize

getPaperSize

getPasswordSaveOption

getRevisionAuthorName

getSensitivityOfComparison

getUserMasterPath

isCalculateCoordinates

isCompareBookmarks

isCompareDocumentProperty

isCompareVariableProperty

isDetectStyleChanges

isDirectoryCompare

isExtendedSummaryPage

isGenerateSummaryPage

isHeaderFootersComparison

isLeaveGaps

isMarkChangedContent

isMarkNestedContent

isShowDeletedContent

isShowInsertedContent

isShowOnlyChanged

isShowOnlySummaryPage

isShowRevisions

isWordTrackChanges

setCalculateCoordinates

setCalculateCoordinatesMode

setChangedItemStyle

setCompareBookmarks

setCompareDocumentProperty

setCompareVariableProperty

setComparisonType

setDeletedItemStyle

setDetalisationLevel

setDetectStyleChanges

setDiagramMasterSetting

setDirectoryCompare

setExtendedSummaryPage

setFolderComparisonExtension

setGenerateSummaryPage

setHeaderFootersComparison

setInsertedItemStyle

setLeaveGaps

setMarkChangedContent

setMarkLineBreaks

setMarkNestedContent

setOriginalSize

setPaperSize

setPasswordSaveOption

setRevisionAuthorName

setSensitivityOfComparison

setShowDeletedContent

setShowInsertedContent

setShowOnlyChanged

setShowOnlySummaryPage

setShowRevisions

setUserMasterPath

setWordsSeparatorChars

setWordTrackChanges