View Javadoc
1   /*
2    * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
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.errors;
45  
46  import java.util.ArrayList;
47  import java.util.Collection;
48  import java.util.Collections;
49  import java.util.List;
50  
51  import org.eclipse.jgit.internal.JGitText;
52  
53  /**
54   * An exception detailing multiple reasons for failure.
55   */
56  public class CompoundException extends Exception {
57  	private static final long serialVersionUID = 1L;
58  
59  	private static String format(Collection<Throwable> causes) {
60  		final StringBuilder msg = new StringBuilder();
61  		msg.append(JGitText.get().failureDueToOneOfTheFollowing);
62  		for (Throwable c : causes) {
63  			msg.append("  "); //$NON-NLS-1$
64  			msg.append(c.getMessage());
65  			msg.append("\n"); //$NON-NLS-1$
66  		}
67  		return msg.toString();
68  	}
69  
70  	private final List<Throwable> causeList;
71  
72  	/**
73  	 * Constructs an exception detailing many potential reasons for failure.
74  	 *
75  	 * @param why
76  	 *            Two or more exceptions that may have been the problem.
77  	 */
78  	public CompoundException(Collection<Throwable> why) {
79  		super(format(why));
80  		causeList = Collections.unmodifiableList(new ArrayList<>(why));
81  	}
82  
83  	/**
84  	 * Get the complete list of reasons why this failure happened.
85  	 *
86  	 * @return unmodifiable collection of all possible reasons.
87  	 */
88  	public List<Throwable> getAllCauses() {
89  		return causeList;
90  	}
91  }