source/mir/util/ExceptionRoutines.java

   1 /*
   2  * Copyright (C) 2001-2006 The Mir-coders group
   3  *
   4  * This file is part of Mir.
   5  *
   6  * Mir is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Mir is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with Mir; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  * In addition, as a special exception, The Mir-coders gives permission to link
  21  * the code of this program with  any library licensed under the Apache Software License,
  22  * and distribute linked combinations including the two.  You must obey the
  23  * GNU General Public License in all respects for all of the code used other than
  24  * the above mentioned libraries.  If you modify this file, you may extend this
  25  * exception to your version of the file, but you are not obligated to do so.
  26  * If you do not wish to do so, delete this exception statement from your version.
  27  */
  28 package mir.util;
  29
  30 import multex.Failure;
  31 import org.xml.sax.SAXException;
  32
  33 import java.io.PrintWriter;
  34 import java.io.StringWriter;
  35 import java.lang.reflect.InvocationTargetException;
  36
  37 /**
  38  * Routines to assist in handling and throwing exceptions</p>
  39  */
  40
  41 public class ExceptionRoutines {
  42   protected ExceptionRoutines() {
  43   }
  44
  45   /**
  46    * Traces an exception to it's root cause, using all known exception types that support
  47    *   cause exceptions.
  48    *
  49    * @return the cause (if found)
  50    */
  51
  52   public static Throwable traceCauseException(Throwable anException) {
  53     Throwable result = anException;
  54
  55     while (true) {
  56       if ((result instanceof Failure) && (((Failure) result).getCause()!=null)) {
  57         result = ((Failure) result).getCause();
  58       }
  59       else if ((result instanceof SAXException) && (((SAXException) result).getException()!=null)) {
  60         result = ((SAXException) result).getException();
  61       }
  62       else if ((result instanceof InvocationTargetException) && (((InvocationTargetException) result).getTargetException()!=null)) {
  63         result = ((InvocationTargetException) result).getTargetException();
  64       }
  65       else
  66         break;
  67     }
  68
  69     return result;
  70   }
  71
  72   /**
  73    * Prints an exception's stacktrace to a <code>String</code>
  74    */
  75   public static String getStackTrace(Throwable aThrowable) {
  76     StringWriter writer = new StringWriter();
  77     aThrowable.printStackTrace(new PrintWriter(writer));
  78     return writer.toString();
  79   }
  80 }