View Javadoc
1   /*
2    * Copyright (C) 2007, Dave Watson <dwatson@mimvista.com>
3    * Copyright (C) 2007, Robin Rosenberg <robin.rosenberg@dewire.com>
4    * Copyright (C) 2006, Shawn O. Pearce <spearce@spearce.org>
5    * and other copyright owners as documented in the project's IP log.
6    *
7    * This program and the accompanying materials are made available
8    * under the terms of the Eclipse Distribution License v1.0 which
9    * accompanies this distribution, is reproduced below, and is
10   * available at http://www.eclipse.org/org/documents/edl-v10.php
11   *
12   * All rights reserved.
13   *
14   * Redistribution and use in source and binary forms, with or
15   * without modification, are permitted provided that the following
16   * conditions are met:
17   *
18   * - Redistributions of source code must retain the above copyright
19   *   notice, this list of conditions and the following disclaimer.
20   *
21   * - Redistributions in binary form must reproduce the above
22   *   copyright notice, this list of conditions and the following
23   *   disclaimer in the documentation and/or other materials provided
24   *   with the distribution.
25   *
26   * - Neither the name of the Eclipse Foundation, Inc. nor the
27   *   names of its contributors may be used to endorse or promote
28   *   products derived from this software without specific prior
29   *   written permission.
30   *
31   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
32   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
33   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
34   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
35   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
36   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
37   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
38   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
39   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
40   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
42   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
43   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44   */
45  
46  package org.eclipse.jgit.errors;
47  
48  import java.io.IOException;
49  import java.text.MessageFormat;
50  
51  import org.eclipse.jgit.internal.JGitText;
52  
53  /**
54   * Exception thrown if a conflict occurs during a merge checkout.
55   */
56  public class CheckoutConflictException extends IOException {
57  	private static final long serialVersionUID = 1L;
58  
59  	private final String[] conflicting;
60  
61  	/**
62  	 * Construct a CheckoutConflictException for the specified file
63  	 *
64  	 * @param file
65  	 *            relative path of a file
66  	 */
67  	public CheckoutConflictException(String file) {
68  		super(MessageFormat.format(JGitText.get().checkoutConflictWithFile, file));
69  		conflicting = new String[] { file };
70  	}
71  
72  	/**
73  	 * Construct a CheckoutConflictException for the specified set of files
74  	 *
75  	 * @param files
76  	 *            an array of relative file paths
77  	 */
78  	public CheckoutConflictException(String[] files) {
79  		super(MessageFormat.format(JGitText.get().checkoutConflictWithFiles, buildList(files)));
80  		conflicting = files;
81  	}
82  
83  	/**
84  	 * Get the relative paths of the conflicting files
85  	 *
86  	 * @return the relative paths of the conflicting files (relative to the
87  	 *         working directory root).
88  	 * @since 4.4
89  	 */
90  	public String[] getConflictingFiles() {
91  		return conflicting;
92  	}
93  
94  	private static String buildList(String[] files) {
95  		StringBuilder builder = new StringBuilder();
96  		for (String f : files) {
97  			builder.append("\n"); //$NON-NLS-1$
98  			builder.append(f);
99  		}
100 		return builder.toString();
101 	}
102 }