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

java.lang.Object
- com.groupdocs.comparison.result.ChangeInfo

public class ChangeInfo
extends Object

The ChangeInfo class represents information about a specific change in a document comparison.

It provides details such as the type of change, the affected area, and the content before and after the change. Use this class to retrieve information about individual changes within a comparison result.

Example usage:


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

     comparer.compare(resultFile);
     // Get a list of changes from the comparison result
     ChangeInfo[] changes = comparer.getChanges();
     // Iterate through the changes and retrieve information
     for (ChangeInfo change : changes) {
         ChangeType changeType = change.getType();
         String componentType = change.getComponentType();
         PageInfo pageInfo = change.getPageInfo();
         // Process the change information as needed
         // ...
     }
 }

See Also:: Comparer, ChangeType, PageInfo

Constructor Summary

Constructors
Constructor and Description

ChangeInfo()

Constructors
Constructor and Description
`ChangeInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`getAuthors()` Gets the list of authors.
`Rectangle`	`getBox()` Gets coordinates of changed element on the page.
`ComparisonAction`	`getComparisonAction()` Gets the action that will be applied to the change.
`String`	`getComponentType()` Gets the type of the changed component.
`int`	`getId()` Gets unique id of the change.
`PageInfo`	`getPageInfo()` Gets information about the page, on which current change was found.
`String`	`getSourceText()` Gets changed text from source document.
`List<StyleChangeInfo>`	`getStyleChanges()` Gets the list of style changes.
`String`	`getTargetText()` Gets changed text from target document.
`String`	`getText()` Gets text value of the change.
`ChangeType`	`getType()` Gets the type of the change represented by enum `ChangeType`.
`void`	`setAuthors(List<String> value)` Sets the list of authors.
`void`	`setBox(Rectangle value)` Sets coordinates of changed element on the page.
`void`	`setComparisonAction(ComparisonAction value)` Sets the action that should be applied to the change.
`void`	`setComponentType(String value)` Sets the type of the changed component.
`void`	`setId(int value)` Sets unique id of the change.
`void`	`setPageInfo(PageInfo value)` Sets information about the page, on which current change was found.
`void`	`setSourceText(String value)` Sets changed text from source document.
`void`	`setStyleChanges(List<StyleChangeInfo> value)` Sets the list of style changes.
`void`	`setTargetText(String value)` Sets changed text from target document.
`void`	`setText(String value)` Sets text value of the change.
`String`	`toString()`

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

- Constructor Detail
  - ChangeInfo
```
public ChangeInfo()
```
- Method Detail
  - getAuthors
```
public final List<String> getAuthors()
```
    Gets the list of authors.
    
    Returns:
    
    the list of authors
  - getBox
```
public final Rectangle getBox()
```
    Gets coordinates of changed element on the page.
    
    Returns:
    
    coordinates of changed element
  - getComparisonAction
```
public final ComparisonAction getComparisonAction()
```
    Gets the action that will be applied to the change.
    Action (ComparisonAction.ACCEPT or ComparisonAction.REJECT) tells comparison what to do with this change.
    
    Returns:
    
    the action that will be applied to the change
  - getComponentType
```
public String getComponentType()
```
    Gets the type of the changed component.
    
    Returns:
    
    the type of the changed component
  - getId
```
public final int getId()
```
    Gets unique id of the change.
    
    Returns:
    
    the id of the change
  - getPageInfo
```
public final PageInfo getPageInfo()
```
    Gets information about the page, on which current change was found.
    
    Returns:
    
    information about the page
  - getSourceText
```
public String getSourceText()
```
    Gets changed text from source document.
    
    Returns:
    
    the changed text
  - getStyleChanges
```
public final List<StyleChangeInfo> getStyleChanges()
```
    Gets the list of style changes.
    
    Returns:
    
    the list of style changes
  - getTargetText
```
public String getTargetText()
```
    Gets changed text from target document.
    
    Returns:
    
    the changed text
  - getText
```
public final String getText()
```
    Gets text value of the change.
    
    Returns:
    
    text value of the change
  - getType
```
public final ChangeType getType()
```
    Gets the type of the change represented by enum ChangeType.
    
    Returns:
    
    the type of the change
  - setAuthors
```
public final void setAuthors(List<String> value)
```
    Sets the list of authors.
    
    Parameters:
    
    value - The list of authors
  - setBox
```
public final void setBox(Rectangle value)
```
    Sets coordinates of changed element on the page.
    
    Parameters:
    
    value - Coordinates of changed element, not null
  - setComparisonAction
```
public final void setComparisonAction(ComparisonAction value)
```
    Sets the action that should be applied to the change.
    Action (ComparisonAction.ACCEPT or ComparisonAction.REJECT) tells comparison what to do with this change.
    
    Parameters:
    
    value - The action that should be applied to the change
  - setComponentType
```
public void setComponentType(String value)
```
    Sets the type of the changed component.
    
    Parameters:
    
    value - The type of the changed component
  - setId
```
public final void setId(int value)
```
    Sets unique id of the change.
    
    Parameters:
    
    value - The id of the change
  - setPageInfo
```
public final void setPageInfo(PageInfo value)
```
    Sets information about the page, on which current change was found.
    
    Parameters:
    
    value - Information about the page
  - setSourceText
```
public void setSourceText(String value)
```
    Sets changed text from source document.
    
    Parameters:
    
    value - The changed text
  - setStyleChanges
```
public final void setStyleChanges(List<StyleChangeInfo> value)
```
    Sets the list of style changes.
    
    Parameters:
    
    value - The list of style changes
  - setTargetText
```
public void setTargetText(String value)
```
    Sets changed text from target document.
    
    Parameters:
    
    value - The changed text
  - setText
```
public final void setText(String value)
```
    Sets text value of the change.
    
    Parameters:
    
    value - Text value of the change
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ChangeInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ChangeInfo

Method Detail

getAuthors

getBox

getComparisonAction

getComponentType

getId

getPageInfo

getSourceText

getStyleChanges

getTargetText

getText

getType

setAuthors

setBox

setComparisonAction

setComponentType

setId

setPageInfo

setSourceText

setStyleChanges

setTargetText

setText

toString