1 /*
2 * Copyright (C) 2009, Christian Halstrick <christian.halstrick@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.merge;
45
46 import java.io.IOException;
47 import java.io.OutputStream;
48 import java.util.ArrayList;
49 import java.util.List;
50
51 import org.eclipse.jgit.diff.RawText;
52
53 /**
54 * A class to convert merge results into a Git conformant textual presentation
55 */
56 public class MergeFormatter {
57 /**
58 * Formats the results of a merge of {@link RawText} objects in a Git
59 * conformant way. This method also assumes that the {@link RawText} objects
60 * being merged are line oriented files which use LF as delimiter. This
61 * method will also use LF to separate chunks and conflict metadata,
62 * therefore it fits only to texts that are LF-separated lines.
63 *
64 * @param out
65 * the outputstream where to write the textual presentation
66 * @param res
67 * the merge result which should be presented
68 * @param seqName
69 * When a conflict is reported each conflicting range will get a
70 * name. This name is following the "<<<<<<< " or ">>>>>>> "
71 * conflict markers. The names for the sequences are given in
72 * this list
73 * @param charsetName
74 * the name of the characterSet used when writing conflict
75 * metadata
76 * @throws IOException
77 */
78 public void formatMerge(OutputStream out, MergeResult<RawText> res,
79 List<String> seqName, String charsetName) throws IOException {
80 new MergeFormatterPass(out, res, seqName, charsetName).formatMerge();
81 }
82
83 /**
84 * Formats the results of a merge of exactly two {@link RawText} objects in
85 * a Git conformant way. This convenience method accepts the names for the
86 * three sequences (base and the two merged sequences) as explicit
87 * parameters and doesn't require the caller to specify a List
88 *
89 * @param out
90 * the {@link OutputStream} where to write the textual
91 * presentation
92 * @param res
93 * the merge result which should be presented
94 * @param baseName
95 * the name ranges from the base should get
96 * @param oursName
97 * the name ranges from ours should get
98 * @param theirsName
99 * the name ranges from theirs should get
100 * @param charsetName
101 * the name of the characterSet used when writing conflict
102 * metadata
103 * @throws IOException
104 */
105 public void formatMerge(OutputStream out, MergeResult res, String baseName,
106 String oursName, String theirsName, String charsetName) throws IOException {
107 List<String> names = new ArrayList<String>(3);
108 names.add(baseName);
109 names.add(oursName);
110 names.add(theirsName);
111 formatMerge(out, res, names, charsetName);
112 }
113 }