1 /*
2 * This file is part of Domingo
3 * an Open Source Java-API to Lotus Notes/Domino
4 * hosted at http://domingo.sourceforge.net
5 *
6 * Copyright (c) 2003-2007 Beck et al. projects GmbH Munich, Germany (http://www.bea.de)
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 */
22
23 package de.bea.domingo.exception;
24
25 import java.io.PrintWriter;
26
27 /***
28 * An interface to be implemented by {@link java.lang.Throwable} extensions
29 * which would like to be able to cascade root exceptions inside themselves.
30 */
31 public interface CascadingThrowable {
32
33 /***
34 * Returns the reference to the exception or error that caused the exception.
35 *
36 * @return throwable that caused the original exception
37 */
38 Throwable getCause();
39
40 /***
41 * Prints the stack trace for this exception only--root cause not
42 * included--using the provided writer. Used by
43 * {@link de.bea.domingo.exception.ExceptionUtil} to write
44 * individual stack traces to a buffer. The implementation of this method
45 * should call <code>super.printStackTrace(out);</code> in most cases.
46 *
47 * @param out The writer to use.
48 */
49 void printPartialStackTrace(PrintWriter out);
50 }