1 /*
2 * Copyright (C) 2010, Sasa Zivkov <sasa.zivkov@sap.com>
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43
44 package org.eclipse.jgit.notes;
45
46 import java.io.IOException;
47
48 import org.eclipse.jgit.lib.ObjectInserter;
49 import org.eclipse.jgit.lib.ObjectReader;
50
51 /**
52 * Three-way note merge operation.
53 * <p>
54 * This operation takes three versions of a note: base, ours and theirs,
55 * performs the three-way merge and returns the merge result.
56 */
57 public interface NoteMerger {
58
59 /**
60 * Merges the conflicting note changes.
61 * <p>
62 * base, ours and their are all notes on the same object.
63 *
64 * @param base
65 * version of the Note
66 * @param ours
67 * version of the Note
68 * @param their
69 * version of the Note
70 * @param reader
71 * the object reader that must be used to read Git objects
72 * @param inserter
73 * the object inserter that must be used to insert Git objects
74 * @return the merge result
75 * @throws org.eclipse.jgit.notes.NotesMergeConflictException
76 * in case there was a merge conflict which this note merger
77 * couldn't resolve
78 * @throws java.io.IOException
79 * in case the reader or the inserter would throw an
80 * java.io.IOException the implementor will most likely want to
81 * propagate it as it can't do much to recover from it
82 */
83 Note merge(Note base, Note ours, Note their, ObjectReader reader,
84 ObjectInserter inserter) throws NotesMergeConflictException,
85 IOException;
86 }
87