source/mir/util/ExceptionRoutines.java

   1 /*
   2  * Copyright (C) 2001, 2002 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  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
  23  * (or with modified versions of the above that use the same license as the above),
  24  * and distribute linked combinations including the two.  You must obey the
  25  * GNU General Public License in all respects for all of the code used other than
  26  * the above mentioned libraries.  If you modify this file, you may extend this
  27  * exception to your version of the file, but you are not obligated to do so.
  28  * If you do not wish to do so, delete this exception statement from your version.
  29  */
  30 package mir.util;
  31
  32 import java.io.PrintWriter;
  33 import java.io.StringWriter;
  34 import java.lang.reflect.InvocationTargetException;
  35
  36 import multex.Failure;
  37
  38 import org.xml.sax.SAXException;
  39
  40 /**
  41  * Routines to assist in handling and throwing exceptions</p>
  42  */
  43
  44 public class ExceptionRoutines {
  45   protected ExceptionRoutines() {
  46   }
  47
  48   /**
  49    * Traces an exception to it's root cause, using all known exception types that support
  50    *   cause exceptions.
  51    *
  52    * @return the cause (if found)
  53    */
  54
  55   public static Throwable traceCauseException(Throwable anException) {
  56     Throwable result = anException;
  57
  58     while (true) {
  59       if ((result instanceof Failure) && (((Failure) result).getCause()!=null)) {
  60         result = ((Failure) result).getCause();
  61       }
  62       else if ((result instanceof SAXException) && (((SAXException) result).getException()!=null)) {
  63         result = ((SAXException) result).getException();
  64       }
  65       else if ((result instanceof InvocationTargetException) && (((InvocationTargetException) result).getTargetException()!=null)) {
  66         result = ((InvocationTargetException) result).getTargetException();
  67       }
  68       else
  69         break;
  70     }
  71
  72     return result;
  73   }
  74
  75   /**
  76    * Prints an exception's stacktrace to a <code>String</code>
  77    */
  78   public static String getStackTrace(Throwable aThrowable) {
  79     StringWriter writer = new StringWriter();
  80     aThrowable.printStackTrace(new PrintWriter(writer));
  81     return writer.toString();
  82   }
  83 }