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.poem;
47
48 /**
49 * Base class for all Poem exceptions.
50 * <p>
51 * NOTE All POEM exceptions are unchecked.
52 */
53 public abstract class PoemException extends RuntimeException {
54
55 /**
56 *
57 */
58 private static final long serialVersionUID = 3801377407054077460L;
59 /**
60 * Pre-java 1.4 initial cause.
61 */
62 public Exception subException;
63
64 /** Constructor. */
65 public PoemException(Exception subException) {
66 this((String)null, subException);
67 }
68
69 /** Constructor. */
70 public PoemException() {
71 this((String)null);
72 }
73 /**
74 * Constructor with message and initial cause.
75 */
76 public PoemException(String message, Exception subException) {
77 this(message);
78 initCause(subException);
79 }
80 /**
81 * Constructor with message.
82 */
83 public PoemException(String message) {
84 super(message);
85 }
86 /**
87 * No longer overrides standard method.
88 * {@inheritDoc}
89 * @see java.lang.Throwable#initCause(java.lang.Throwable)
90 */
91 public Throwable initCause(Throwable cause) {
92 subException = (Exception)cause;
93 // Java 1.3
94 // return this;
95 return super.initCause(cause);
96 }
97
98
99 /**
100 * @return the message from super class
101 */
102 public String getCoreMessage() {
103 return super.getMessage();
104 }
105
106 /**
107 * The detail message which may be null.
108 * {@inheritDoc}
109 * @see java.lang.Throwable#getMessage()
110 */
111 public String getMessage() {
112 return this.getClass().getName() +
113 (super.getMessage() == null ? "" : ": " + super.getMessage()) +
114 (subException == null ? "" : "\n" + subException);
115 }
116
117 /**
118 * @return the actual exception
119 */
120 public Exception innermostException() {
121 return subException == null ? this :
122 subException instanceof PoemException ?
123 ((PoemException)subException).innermostException() :
124 subException;
125 }
126
127 /**
128 * {@inheritDoc}
129 * @see java.lang.Throwable#printStackTrace()
130 */
131 public void printStackTrace() {
132 if (subException == null)
133 super.printStackTrace();
134 else {
135 System.err.println(this);
136 System.err.println("---");
137 innermostException().printStackTrace();
138 }
139 }
140
141 /**
142 * {@inheritDoc}
143 * @see java.lang.Throwable#printStackTrace(java.io.PrintStream)
144 */
145 public void printStackTrace(java.io.PrintStream s) {
146 if (subException == null)
147 super.printStackTrace(s);
148 else {
149 s.println(this);
150 s.println("---");
151 innermostException().printStackTrace(s);
152 }
153 }
154
155 /**
156 * {@inheritDoc}
157 * @see java.lang.Throwable#printStackTrace(java.io.PrintWriter)
158 */
159 public void printStackTrace(java.io.PrintWriter w) {
160 if (subException == null)
161 super.printStackTrace(w);
162 else {
163 w.println(this);
164 w.println("---");
165 innermostException().printStackTrace(w);
166 }
167 }
168 }