organising imports
[mir.git] / source / mir / util / ExceptionFunctions.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 the com.oreilly.servlet library, any library
22  * licensed under the Apache Software License, The Sun (tm) Java Advanced
23  * Imaging library (JAI), The Sun JIMI library (or with modified versions of
24  * the above that use the same license as the above), and distribute linked
25  * combinations including the two.  You must obey the GNU General Public
26  * License in all respects for all of the code used other than the above
27  * mentioned libraries.  If you modify this file, you may extend this exception
28  * to your version of the file, but you are not obligated to do so.  If you do
29  * not wish to do so, delete this exception statement from your version.
30  */
31
32 package mir.util;
33
34 import java.lang.reflect.InvocationTargetException;
35
36 import multex.Failure;
37
38 import org.xml.sax.SAXException;
39
40 /**
41  *
42  * <p>Title: ExceptionFunctions </p>
43  * <p>Description: Functions to assist handling and throwing exceptions</p>
44  * <p>Copyright: Copyright (c) 2003</p>
45  * <p>Company: Mir coders</p>
46  * @author Zapata
47  * @version 1.0
48  */
49
50 public class ExceptionFunctions {
51   private ExceptionFunctions() {
52   }
53
54   /**
55    * Traces an exception to it's root cause, using all known exception types that support
56    *   cause exceptions.
57    *
58    * @param anException
59    * @return the cause (if found)
60    */
61
62   public static Throwable traceCauseException(Throwable anException) {
63     Throwable result = anException;
64
65     while (true) {
66       if ((result instanceof Failure) && (((Failure) result).getCause()!=null)) {
67         result = ((Failure) result).getCause();
68       }
69       else if ((result instanceof SAXException) && (((SAXException) result).getException()!=null)) {
70         result = ((SAXException) result).getException();
71       }
72       else if ((result instanceof InvocationTargetException) && (((InvocationTargetException) result).getTargetException()!=null)) {
73         result = ((InvocationTargetException) result).getTargetException();
74       }
75       else
76         break;
77     }
78
79     return result;
80   }
81 }