Package org.xwiki.diff

Interface DiffManager

@Role
public interface DiffManager

Various diff/merge tools.

Version:

$Id: 47ce477a9e693eeae85268f7ac9a00039e75edc7 $

Method Summary

Modifier and Type	Method	Description
<E> DiffResult<E>	diff(List<E> previous, List<E> next, DiffConfiguration<E> configuration)	Produce a diff between the two provided versions.
<E> MergeResult<E>	merge(List<E> commonAncestor, List<E> next, List<E> current, MergeConfiguration<E> configuration)	Execute a 3-way merge on provided versions.

Method Detail

diff

<E> DiffResult<E> diff(List<E> previous,
                       List<E> next,
                       DiffConfiguration<E> configuration)
                throws DiffException

Produce a diff between the two provided versions.

Type Parameters:

E - the type of compared elements

Parameters:

previous - the previous version of the content to compare

next - the next version of the content to compare

configuration - the configuration of the diff behavior

Returns:

the result of the diff

Throws:

DiffException - error when executing the diff

merge

<E> MergeResult<E> merge(List<E> commonAncestor,
                         List<E> next,
                         List<E> current,
                         MergeConfiguration<E> configuration)
                  throws MergeException

Execute a 3-way merge on provided versions. If a conflict is detected during the merge, no error is triggered and the returned MergeResult object always has a result (see MergeResult.getMerged()): the conflict is automatically fixed with a fallback defined by the MergeConfiguration. If the MergeConfiguration instance contains some ConflictDecision (see MergeConfiguration.setConflictDecisionList(List)), then those decisions are taken into account to solve the conflict. The decision linked to the conflict is retrieved and applied, unless the decision state is still ConflictDecision.DecisionType.UNDECIDED. When a decision is used to solve a conflict, the conflict is not recorded in the MergeResult. If the decision is ConflictDecision.DecisionType.UNDECIDED, or if no decision is available for this conflict, then the fallback version defined in the MergeConfiguration (see MergeConfiguration.setFallbackOnConflict(MergeConfiguration.Version)) is used to fix the conflict, but in that case the conflict is recorded in the returned MergeResult. Finally the configuration parameter accepts a null value: in that case, the fallback version is always the current version.

Type Parameters:

E - the type of compared elements

Parameters:

commonAncestor - the common ancestor of the two versions of the content to compare

next - the next version of the content to compare

current - the current version of the content to compare

configuration - the configuration of the merge behavior

Returns:

the result of the merge

Throws:

MergeException - error when executing the merge