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

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

Enclosing class:: CompareOptions

public static class CompareOptions.Builder
extends Object

A CompareOptions builder.

Constructor Summary

Constructors
Constructor and Description

Builder()
Instantiates a new Builder object.

Constructors
Constructor and Description
`Builder()` Instantiates a new Builder object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompareOptions`	`build()` Returns the object that was created and configured along with the builder.
`CompareOptions.Builder`	`setCalculateCoordinates(boolean value)` Sets a flag that indicates whether to calculate coordinates for changed components.
`CompareOptions.Builder`	`setCalculateCoordinatesMode(com.groupdocs.comparison.options.enums.CalculateCoordinatesModeEnumeration value)` Sets a calculate coordinates mode as `CalculateCoordinatesModeEnumeration` object.
`CompareOptions.Builder`	`setChangedItemStyle(StyleSettings value)` Sets a style settings that will be applied to changed items.
`CompareOptions.Builder`	`setCompareBookmarks(boolean value)` Sets a flag that indicates whether bookmarks in Word documents should be compared.
`CompareOptions.Builder`	`setCompareDocumentProperty(boolean value)` Sets a flag that indicates whether built and custom properties in Word documents should be compared.
`CompareOptions.Builder`	`setCompareVariableProperty(boolean value)` Sets a flag that indicates whether variables properties in Word documents should be compared.
`CompareOptions.Builder`	`setComparisonType(ComparisonType comparisonType)` Sets a type of source and target documents as `ComparisonType` object so that Comparison will know how to compare them.
`CompareOptions.Builder`	`setDeletedItemStyle(StyleSettings value)` Sets a style settings that will be applied to deleted items.
`CompareOptions.Builder`	`setDetalisationLevel(DetalisationLevel value)` Sets a level of comparison detalization represented as `DetalisationLevel`.
`CompareOptions.Builder`	`setDetectStyleChanges(boolean value)` Sets a flag that indicates whether to detect style changes or not.
`CompareOptions.Builder`	`setDiagramMasterSetting(DiagramMasterSetting value)` Sets a setting of master page for Diagram documents represented by `DiagramMasterSetting` object.
`CompareOptions.Builder`	`setDirectoryCompare(boolean value)`
`CompareOptions.Builder`	`setExtendedSummaryPage(boolean value)` Sets a flag that indicates whether to add extended file comparison information to the summary page or not.
`CompareOptions.Builder`	`setFolderComparisonExtension(com.groupdocs.comparison.options.enums.FolderComparisonExtension value)`
`CompareOptions.Builder`	`setGenerateSummaryPage(boolean value)` Sets a flag that indicates whether to add summary page with detected changes statistics to resultant document or not.
`CompareOptions.Builder`	`setHeaderFootersComparison(boolean value)` Sets a flag that indicates whether to compare header/footer contents.
`CompareOptions.Builder`	`setInsertedItemStyle(StyleSettings value)` Sets a style settings that will be applied to inserted items.
`CompareOptions.Builder`	`setLeaveGaps(boolean value)` Sets a flag that determines whether to leave empty lines instead of inserted/deleted components or not.
`CompareOptions.Builder`	`setMarkChangedContent(boolean value)` Sets a flag that indicates whether frames for shapes in Word Processing and for rectangles in Image documents will be used.
`CompareOptions.Builder`	`setMarkNestedContent(boolean value)` Sets a flag that indicates whether to mark the children of the deleted or inserted elements as deleted or inserted.
`CompareOptions.Builder`	`setOriginalSize(OriginalSize value)` Sets an original sizes of compared documents represented by `OriginalSize` object.
`CompareOptions.Builder`	`setPaperSize(PaperSize value)` Sets a size of a paper in result document as `PaperSize` object.
`CompareOptions.Builder`	`setPasswordSaveOption(PasswordSaveOption value)` Sets a password save option represented by `PasswordSaveOption` object.
`CompareOptions.Builder`	`setRevisionAuthorName(String value)`
`CompareOptions.Builder`	`setSensitivityOfComparison(int value)` Sets a sensitivity of comparison.
`CompareOptions.Builder`	`setShowDeletedContent(boolean value)` Sets a flag that indicates whether to show deleted components in resultant document or not.
`CompareOptions.Builder`	`setShowOnlyChanged(boolean value)`
`CompareOptions.Builder`	`setShowRevisions(boolean value)` Sets a flag that indicates whether others revisions in the resulting document should be displayed.
`CompareOptions.Builder`	`setUserMasterPath(String value)`
`CompareOptions.Builder`	`setWordsSeparatorChars(char[] value)` Sets an array of delimiters which will be used to split text into words.
`CompareOptions.Builder`	`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
  - Builder
```
public Builder()
```
    Instantiates a new Builder object.
- Method Detail
  - build
```
public final CompareOptions build()
```
    Returns the object that was created and configured along with the builder.
    
    Returns:
    
    the compare options object
  - setCalculateCoordinates
```
public CompareOptions.Builder 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 CompareOptions.Builder setCalculateCoordinatesMode(com.groupdocs.comparison.options.enums.CalculateCoordinatesModeEnumeration value)
```
    Sets a calculate coordinates mode as CalculateCoordinatesModeEnumeration object.
    
    Parameters:
    
    value - The calculate coordinates mode
  - setChangedItemStyle
```
public CompareOptions.Builder 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 CompareOptions.Builder 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 CompareOptions.Builder 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 CompareOptions.Builder 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 CompareOptions.Builder 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 CompareOptions.Builder 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 CompareOptions.Builder 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 CompareOptions.Builder 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 CompareOptions.Builder 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 CompareOptions.Builder setDirectoryCompare(boolean value)
```
  - setExtendedSummaryPage
```
public CompareOptions.Builder 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 CompareOptions.Builder setFolderComparisonExtension(com.groupdocs.comparison.options.enums.FolderComparisonExtension value)
```
  - setGenerateSummaryPage
```
public CompareOptions.Builder 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 CompareOptions.Builder 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 CompareOptions.Builder 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 CompareOptions.Builder 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 CompareOptions.isShowInsertedContent() or CompareOptions.isShowDeletedContent() properties.
    
    Parameters:
    
    value - true if empty lines should be displayed instead of inserted/deleted components, otherwise false
  - setMarkChangedContent
```
public CompareOptions.Builder 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
  - setMarkNestedContent
```
public CompareOptions.Builder 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 CompareOptions.Builder 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 CompareOptions.Builder 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 CompareOptions.Builder 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 CompareOptions.Builder setRevisionAuthorName(String value)
```
  - setSensitivityOfComparison
```
public CompareOptions.Builder 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 CompareOptions.Builder 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
  - setShowOnlyChanged
```
public CompareOptions.Builder setShowOnlyChanged(boolean value)
```
  - setShowRevisions
```
public CompareOptions.Builder 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 CompareOptions.Builder setUserMasterPath(String value)
```
  - setWordsSeparatorChars
```
public CompareOptions.Builder 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 CompareOptions.Builder 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.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

setCalculateCoordinates

setCalculateCoordinatesMode

setChangedItemStyle

setCompareBookmarks

setCompareDocumentProperty

setCompareVariableProperty

setComparisonType

setDeletedItemStyle

setDetalisationLevel

setDetectStyleChanges

setDiagramMasterSetting

setDirectoryCompare

setExtendedSummaryPage

setFolderComparisonExtension

setGenerateSummaryPage

setHeaderFootersComparison

setInsertedItemStyle

setLeaveGaps

setMarkChangedContent

setMarkNestedContent

setOriginalSize

setPaperSize

setPasswordSaveOption

setRevisionAuthorName

setSensitivityOfComparison

setShowDeletedContent

setShowOnlyChanged

setShowRevisions

setUserMasterPath

setWordsSeparatorChars

setWordTrackChanges