001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2003 Jcorporate Ltd. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by Jcorporate Ltd.
021: * (http://www.jcorporate.com/)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. "Jcorporate" and product names such as "Expresso" must
026: * not be used to endorse or promote products derived from this
027: * software without prior written permission. For written permission,
028: * please contact info@jcorporate.com.
029: *
030: * 5. Products derived from this software may not be called "Expresso",
031: * or other Jcorporate product names; nor may "Expresso" or other
032: * Jcorporate product names appear in their name, without prior
033: * written permission of Jcorporate Ltd.
034: *
035: * 6. No product derived from this software may compete in the same
036: * market space, i.e. framework, without prior written permission
037: * of Jcorporate Ltd. For written permission, please contact
038: * partners@jcorporate.com.
039: *
040: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
041: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
042: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
043: * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
044: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
045: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
046: * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
047: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
048: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
049: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
050: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
051: * SUCH DAMAGE.
052: * ====================================================================
053: *
054: * This software consists of voluntary contributions made by many
055: * individuals on behalf of the Jcorporate Ltd. Contributions back
056: * to the project(s) are encouraged when you make modifications.
057: * Please send them to support@jcorporate.com. For more information
058: * on Jcorporate Ltd. and its products, please see
059: * <http://www.jcorporate.com/>.
060: *
061: * Portions of this software are based upon other open source
062: * products and are subject to their respective licenses.
063: */
064:
065: package com.jcorporate.expresso.kernel.exception;
066:
067: import java.io.PrintStream;
068: import java.io.PrintWriter;
069:
070: /**
071: * Enhanced Exception class to allow Exception chaining. This helps
072: * indicate the origin of an exception more clearly than simply passing
073: * on the original message
074: * Creation date: (4/15/00 5:47:38 PM)
075: *
076: * @author Michael Nash
077: */
078: public class ChainedException extends Exception {
079: private Throwable nested = null;
080: private int errorNumber = 0;
081:
082: /**
083: * Normal no-args constructor
084: */
085: public ChainedException() {
086: super ();
087: } /* ChaninedException() */
088:
089: /**
090: * Normal constructor with a single message
091: *
092: * @param s The exception message
093: */
094: public ChainedException(String s) {
095: super (s);
096: } /* Chained Exception */
097:
098: /**
099: * Specify an error number
100: *
101: * @param s the message
102: * @param newErrorNumber The error number to assign
103: */
104: public ChainedException(String s, int newErrorNumber) {
105: super (s);
106: errorNumber = newErrorNumber;
107: }
108:
109: /**
110: * Constructor with a single message and a nested exception
111: *
112: * @param message The exception message
113: * @param newNested The nested item
114: */
115: public ChainedException(String message, Throwable newNested) {
116: super (message);
117: nested = newNested;
118: } /* ChainedException(String, Throwable) */
119:
120: /**
121: * Constructor with a single message and a nested exception with error number
122: *
123: * @param message The exception message
124: * @param newNested The nested item
125: * @param newErrorNumber the error number associated with the exception
126: */
127: public ChainedException(String message, Throwable newNested,
128: int newErrorNumber) {
129: super (message);
130: nested = newNested;
131: errorNumber = newErrorNumber;
132: } /* ChainedException(String, Throwable) */
133:
134: /**
135: * Constructor with no message and a nested exception
136: *
137: * @param newNested The nested exception
138: */
139: public ChainedException(Throwable newNested) {
140: nested = newNested;
141: } /* ChainedException(Throwable) */
142:
143: /**
144: * Constructor with no message and a nested exception, but with an error number
145: *
146: * @param newNested The nested exception
147: * @param newErrorNumber the error number associated with the exception message
148: */
149: public ChainedException(Throwable newNested, int newErrorNumber) {
150: nested = newNested;
151: errorNumber = newErrorNumber;
152: } /* ChainedException(Throwable) */
153:
154: /**
155: * Extend getMessage to return the nested message (if any) if we don't have one
156: *
157: * @return java.lang.String
158: */
159: public String getMessage() {
160: String myMessage = super .getMessage();
161:
162: if ((myMessage == null) && (nested != null)) {
163: myMessage = ("Nested exception: " + omitPackages(nested)
164: + ": " + nested.getMessage());
165: }
166:
167: return myMessage;
168: } /* getMessage() */
169:
170: /**
171: * utility to get just name of class
172: *
173: * @param obj the object of the given class, the name of which will be returned
174: * @return name of class, less any package prefix
175: */
176: public static String omitPackages(Object obj) {
177: int i = obj.getClass().getPackage().getName().length();
178: if (i > 0) {
179: i++;
180: }
181: return obj.getClass().getName().substring(i);
182: }
183:
184: /**
185: * Return the error number if one was supplied
186: *
187: * @return integer: the error number specified (or zero if non was specified)
188: */
189: public int getErrorNumber() {
190: return errorNumber;
191: }
192:
193: /**
194: * Extend printStackTrace to handle the nested exception correctly.
195: */
196: public void printStackTrace() {
197: if (nested != null) {
198: nested.printStackTrace();
199: }
200: super .printStackTrace();
201: } /* printStackTrace() */
202:
203: /**
204: * Extend printStackTrace to handle the nested Exception
205: *
206: * @param p The PrintStream to write the exception messages into
207: */
208: public void printStackTrace(PrintStream p) {
209: if (nested != null) {
210: nested.printStackTrace(p);
211: }
212: super .printStackTrace(p);
213:
214: } /* printStackTrace(PrintStream) */
215:
216: /**
217: * Extend printStackTrace to handle the nested Exception
218: *
219: * @param p The PrintWriter to write the exception messages into
220: */
221: public void printStackTrace(PrintWriter p) {
222: if (nested != null) {
223: nested.printStackTrace(p);
224: }
225: super .printStackTrace(p);
226: } /* printStackTrace(PrintWriter) */
227:
228: /**
229: * Retrieve the nested exception
230: *
231: * @return the nested Exception
232: */
233: public Throwable getNested() {
234: return nested;
235: } /* getNested() */
236:
237: } /* ChainedException */
|