org.spearce.jgit/src/org/spearce/jgit/errors/CompoundException.java

   1 /*
   2  * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
   3  *
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or
   7  * without modification, are permitted provided that the following
   8  * conditions are met:
   9  *
  10  * - Redistributions of source code must retain the above copyright
  11  *   notice, this list of conditions and the following disclaimer.
  12  *
  13  * - Redistributions in binary form must reproduce the above
  14  *   copyright notice, this list of conditions and the following
  15  *   disclaimer in the documentation and/or other materials provided
  16  *   with the distribution.
  17  *
  18  * - Neither the name of the Git Development Community nor the
  19  *   names of its contributors may be used to endorse or promote
  20  *   products derived from this software without specific prior
  21  *   written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  24  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  25  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  26  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  28  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  30  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  33  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  35  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 package org.spearce.jgit.errors;
  39
  40 import java.util.ArrayList;
  41 import java.util.Collection;
  42 import java.util.Collections;
  43 import java.util.List;
  44
  45 /** An exception detailing multiple reasons for failure. */
  46 public class CompoundException extends Exception {
  47         private static final long serialVersionUID = 1L;
  48
  49         private static String format(final Collection<Throwable> causes) {
  50                 final StringBuilder msg = new StringBuilder();
  51                 msg.append("Failure due to one of the following:");
  52                 for (final Throwable c : causes) {
  53                         msg.append("  ");
  54                         msg.append(c.getMessage());
  55                         msg.append("\n");
  56                 }
  57                 return msg.toString();
  58         }
  59
  60         private final List<Throwable> causeList;
  61
  62         /**
  63          * Constructs an exception detailing many potential reasons for failure.
  64          *
  65          * @param why
  66          *            Two or more exceptions that may have been the problem.
  67          */
  68         public CompoundException(final Collection<Throwable> why) {
  69                 super(format(why));
  70                 causeList = Collections.unmodifiableList(new ArrayList<Throwable>(why));
  71         }
  72
  73         /**
  74          * Get the complete list of reasons why this failure happened.
  75          *
  76          * @return unmodifiable collection of all possible reasons.
  77          */
  78         public List<Throwable> getAllCauses() {
  79                 return causeList;
  80         }
  81 }