@API(type=NOT_EXTENDABLE,
src=PUBLIC)
public interface AuthorDifferencePerformer
AuthorDifferencePerformer
is used to compare two Author documents using
a set of options.
The result of the diff is a list with the differences between the resources.Modifier and Type | Method and Description |
---|---|
java.util.List<Difference> |
performDiff(DiffProgressListener diffProgressListener)
Performs the diff operation between the resources represented by the two AuthorAccess.
|
void |
setBaseDocument(AuthorAccess baseAuthorAccess)
Set the base Author document, used to perform a three-way comparison.
|
void |
setDocumentsToCompare(AuthorAccess leftAuthorAccess,
AuthorAccess rightAuthorAccess)
Set the documents to be compared.
|
void |
setOptions(DiffOptions diffOptions)
Set the options used by the diff performer to perform the comparison.
|
void |
stop()
Signal to the diff performer that it must stop.
|
void setBaseDocument(AuthorAccess baseAuthorAccess)
null
.baseAuthorAccess
- The access to the base Author document.void setDocumentsToCompare(AuthorAccess leftAuthorAccess, AuthorAccess rightAuthorAccess)
leftAuthorAccess
- The access to the left Author document.rightAuthorAccess
- The access to the right Author document.void setOptions(DiffOptions diffOptions)
null
meaning a default set of options will be used.diffOptions
- The options.java.util.List<Difference> performDiff(DiffProgressListener diffProgressListener) throws DiffException, java.io.IOException
diffProgressListener
- The DiffProgressListener
notified about the progress of the diff.
It can be null
when the diff progress doesn't need to be monitored.Difference
objects that contain
the start and end offsets in the Author content for each Author document.
DiffOptions.isEnableHierarchicalDiff()
returns true)
then the returned list contains DifferenceParent
elements.DiffException
- If the diff operation fails or it is stopped before it finishes.java.io.IOException
void stop()
© Copyright Syncro Soft SRL 2002 - 2022. All rights reserved.