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