Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
DiffManager | 32 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.diff; | |
21 | ||
22 | import java.util.List; | |
23 | ||
24 | import org.xwiki.component.annotation.Role; | |
25 | ||
26 | /** | |
27 | * Various diff/merge tools. | |
28 | * | |
29 | * @version $Id: 5ed6b58d6e8448787f2d71ae26d2c721900b71df $ | |
30 | */ | |
31 | @Role | |
32 | public interface DiffManager | |
33 | { | |
34 | /** | |
35 | * Produce a diff between the two provided versions. | |
36 | * | |
37 | * @param <E> the type of compared elements | |
38 | * @param previous the previous version of the content to compare | |
39 | * @param next the next version of the content to compare | |
40 | * @param configuration the configuration of the diff behavior | |
41 | * @return the result of the diff | |
42 | * @throws DiffException error when executing the diff | |
43 | */ | |
44 | <E> DiffResult<E> diff(List<E> previous, List<E> next, DiffConfiguration<E> configuration) throws DiffException; | |
45 | ||
46 | /** | |
47 | * Execute a 3-way merge on provided versions. | |
48 | * | |
49 | * @param <E> the type of compared elements | |
50 | * @param commonAncestor the common ancestor of the two versions of the content to compare | |
51 | * @param next the next version of the content to compare | |
52 | * @param current the current version of the content to compare | |
53 | * @param configuration the configuration of the merge behavior | |
54 | * @return the result of the merge | |
55 | * @throws MergeException error when executing the merge | |
56 | */ | |
57 | <E> MergeResult<E> merge(List<E> commonAncestor, List<E> next, List<E> current, MergeConfiguration<E> configuration) | |
58 | throws MergeException; | |
59 | } |