com.groupdocs.comparison.options

Class ApplyChangeOptions

java.lang.Object

com.groupdocs.comparison.options.ApplyChangeOptions

public class ApplyChangeOptions
extends Object

Allows updating the list of changes before applying them to the resulting document.

Example usage:

 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);
     comparer.compare();
     ChangeInfo[] changes = comparer.getChanges();
     changes[0].setComparisonAction(ComparisonAction.REJECT);

     final ApplyChangeOptions applyChangeOptions = new ApplyChangeOptions(changes);

     comparer.applyChanges(resultFile, applyChangeOptions);
 }
 

See Also:

Comparer, ChangeInfo

Constructor Summary

Constructors

Constructor and Description
ApplyChangeOptions() Initializes a new instance of the ApplyChangeOptions class.
ApplyChangeOptions(ChangeInfo[] changes) Initializes a new instance of the ApplyChangeOptions class with array of changes.
ApplyChangeOptions(List<ChangeInfo> changes) Initializes a new instance of the ApplyChangeOptions class with list of changes.

Method Summary

Modifier and Type	Method and Description
ChangeInfo[]	getChanges() Gets an array of changes that must be applied to the resulting document.
boolean	isSaveOriginalState() Gets a flag that determines is original state should be saved.
void	setChanges(ChangeInfo[] value) Sets an array of changes that must be applied to the resulting document.
void	setChanges(List<ChangeInfo> value) Sets a list of changes that must be applied to the resulting document.
void	setSaveOriginalState(boolean saveOriginalState) Sets a flag that determines is original state should be saved.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplyChangeOptions

public ApplyChangeOptions()

Initializes a new instance of the ApplyChangeOptions class.

ApplyChangeOptions

public ApplyChangeOptions(ChangeInfo[] changes)

Initializes a new instance of the ApplyChangeOptions class with array of changes.

Parameters:

changes - The list of changes to be applied

ApplyChangeOptions

public ApplyChangeOptions(List<ChangeInfo> changes)

Initializes a new instance of the ApplyChangeOptions class with list of changes.

Parameters:

changes - The list of changes to be applied

Method Detail

getChanges

public final ChangeInfo[] getChanges()

Gets an array of changes that must be applied to the resulting document.

Returns:

the array of changes to be applied

isSaveOriginalState

public boolean isSaveOriginalState()

Gets a flag that determines is original state should be saved. Default value: false.

Returns:

true if original state should be saved, otherwise false

setChanges

public final void setChanges(ChangeInfo[] value)

Sets an array of changes that must be applied to the resulting document.

Parameters:

value - The array of changes to be applied

setChanges

public final void setChanges(List<ChangeInfo> value)

Sets a list of changes that must be applied to the resulting document.

Parameters:

value - The list of changes to be applied

setSaveOriginalState

public void setSaveOriginalState(boolean saveOriginalState)

Sets a flag that determines is original state should be saved.

Parameters:

saveOriginalState - True if original state should be saved, otherwise false