1 /*
2 * $Source$
3 * $Revision$
4 *
5 * Copyright (C) 2000 William Chesters
6 *
7 * Part of Melati (http://melati.org), a framework for the rapid
8 * development of clean, maintainable web applications.
9 *
10 * Melati is free software; Permission is granted to copy, distribute
11 * and/or modify this software under the terms either:
12 *
13 * a) the GNU General Public License as published by the Free Software
14 * Foundation; either version 2 of the License, or (at your option)
15 * any later version,
16 *
17 * or
18 *
19 * b) any version of the Melati Software License, as published
20 * at http://melati.org
21 *
22 * You should have received a copy of the GNU General Public License and
23 * the Melati Software License along with this program;
24 * if not, write to the Free Software Foundation, Inc.,
25 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
26 * GNU General Public License and visit http://melati.org to obtain the
27 * Melati Software License.
28 *
29 * Feel free to contact the Developers of Melati (http://melati.org),
30 * if you would like to work out a different arrangement than the options
31 * outlined here. It is our intention to allow Melati to be used by as
32 * wide an audience as possible.
33 *
34 * This program is distributed in the hope that it will be useful,
35 * but WITHOUT ANY WARRANTY; without even the implied warranty of
36 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
37 * GNU General Public License for more details.
38 *
39 * Contact details for copyright holder:
40 *
41 * William Chesters <williamc At paneris.org>
42 * http://paneris.org/~williamc
43 * Obrechtstraat 114, 2517VX Den Haag, The Netherlands
44 */
45
46 package org.melati.util;
47
48 /**
49 * Abstract base class for all <code>Exception</code>s within
50 * Melati.
51 */
52 public abstract class MelatiException extends Exception {
53
54 /**
55 * Eclipse generated.
56 */
57 private static final long serialVersionUID = -5635532269280872906L;
58
59 /** A sub-exception we may be wrapping, otherwise null. */
60 public Exception subException;
61
62 /** Constructor with sub-exception. */
63 public MelatiException(Exception subException) {
64 this.subException = subException;
65 }
66 /**
67 * Constructor with message and pre-java 1.4 initial cause.
68 */
69 public MelatiException(String message, Exception subException) {
70 super(message);
71 initCause(subException);
72 }
73
74 /**
75 * Constructor.
76 */
77 public MelatiException() {
78 this((Exception)null);
79 }
80
81 /**
82 * Constructor with message.
83 * @param message a text
84 */
85 public MelatiException(String message) {
86 super(message);
87 }
88 /**
89 * {@inheritDoc}
90 * @see java.lang.Throwable#getMessage()
91 */
92 public String getMessage() {
93 return this.getClass().getName() +
94 (super.getMessage() == null ? "" : ": " + super.getMessage()) +
95 (subException == null ? "" : "\n" + subException);
96 }
97
98 /**
99 * @return the actual cause
100 */
101 public Exception innermostException() {
102 return subException == null ? this :
103 subException instanceof MelatiException ?
104 ((MelatiException)subException).innermostException() :
105 subException instanceof MelatiRuntimeException ?
106 ((MelatiRuntimeException)subException).innermostException() :
107 subException;
108 }
109
110 /**
111 * {@inheritDoc}
112 * @see java.lang.Throwable#printStackTrace()
113 */
114 public void printStackTrace() {
115 if (subException == null)
116 super.printStackTrace();
117 else {
118 System.err.println(this);
119 System.err.println("---");
120 innermostException().printStackTrace();
121 }
122 }
123
124 /**
125 * {@inheritDoc}
126 * @see java.lang.Throwable#printStackTrace(java.io.PrintStream)
127 */
128 public void printStackTrace(java.io.PrintStream s) {
129 if (subException == null)
130 super.printStackTrace(s);
131 else {
132 s.println(this);
133 s.println("---");
134 innermostException().printStackTrace(s);
135 }
136 }
137
138 /**
139 * {@inheritDoc}
140 * @see java.lang.Throwable#printStackTrace(java.io.PrintWriter)
141 */
142 public void printStackTrace(java.io.PrintWriter w) {
143 if (subException == null)
144 super.printStackTrace(w);
145 else {
146 w.println(this);
147 w.println("---");
148 innermostException().printStackTrace(w);
149 }
150 }
151 }