001: /*
002: * @(#)UndeclaredThrowableException.java 1.13 06/10/10
003: *
004: * Copyright 1990-2006 Sun Microsystems, Inc. All Rights Reserved.
005: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
006: *
007: * This program is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU General Public License version
009: * 2 only, as published by the Free Software Foundation.
010: *
011: * This program is distributed in the hope that it will be useful, but
012: * WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * General Public License version 2 for more details (a copy is
015: * included at /legal/license.txt).
016: *
017: * You should have received a copy of the GNU General Public License
018: * version 2 along with this work; if not, write to the Free Software
019: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA
021: *
022: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
023: * Clara, CA 95054 or visit www.sun.com if you need additional
024: * information or have any questions.
025: *
026: */
027:
028: package java.lang.reflect;
029:
030: /**
031: * Thrown by a method invocation on a proxy instance if its invocation
032: * handler's {@link InvocationHandler#invoke invoke} method throws a
033: * checked exception (a <code>Throwable</code> that is not assignable
034: * to <code>RuntimeException</code> or <code>Error</code>) that
035: * is not assignable to any of the exception types declared in the
036: * <code>throws</code> clause of the method that was invoked on the
037: * proxy instance and dispatched to the invocation handler.
038: *
039: * <p>An <code>UndeclaredThrowableException</code> instance contains
040: * the undeclared checked exception that was thrown by the invocation
041: * handler, and it can be retrieved with the
042: * <code>getUndeclaredThrowable()</code> method.
043: * <code>UndeclaredThrowableException</code> extends
044: * <code>RuntimeException</code>, so it is an unchecked exception
045: * that wraps a checked exception.
046: *
047: * <p>As of release 1.4, this exception has been retrofitted to
048: * conform to the general purpose exception-chaining mechanism. The
049: * "undeclared checked exception that was thrown by the invocation
050: * handler" that may be provided at construction time and accessed via
051: * the {@link #getUndeclaredThrowable()} method is now known as the
052: * <i>cause</i>, and may be accessed via the {@link
053: * Throwable#getCause()} method, as well as the aforementioned "legacy
054: * method."
055: *
056: * @author Peter Jones
057: * @version 1.6, 00/02/02
058: * @see InvocationHandler
059: * @since JDK1.3
060: */
061: public class UndeclaredThrowableException extends RuntimeException {
062: static final long serialVersionUID = 330127114055056639L;
063:
064: /**
065: * the undeclared checked exception that was thrown
066: * @serial
067: */
068: private Throwable undeclaredThrowable;
069:
070: /**
071: * Constructs an <code>UndeclaredThrowableException</code> with the
072: * specified <code>Throwable</code>.
073: *
074: * @param undeclaredThrowable the undeclared checked exception
075: * that was thrown
076: */
077: public UndeclaredThrowableException(Throwable undeclaredThrowable) {
078: super ((Throwable) null); // Disallow initCause
079: this .undeclaredThrowable = undeclaredThrowable;
080: }
081:
082: /**
083: * Constructs an <code>UndeclaredThrowableException</code> with the
084: * specified <code>Throwable</code> and a detail message.
085: *
086: * @param undeclaredThrowable the undeclared checked exception
087: * that was thrown
088: * @param s the detail message
089: */
090: public UndeclaredThrowableException(Throwable undeclaredThrowable,
091: String s) {
092: super (s, null); // Disallow initCause
093: this .undeclaredThrowable = undeclaredThrowable;
094: }
095:
096: /**
097: * Returns the <code>Throwable</code> instance wrapped in this
098: * <code>UndeclaredThrowableException</code>, which may be <tt>null</tt>.
099: *
100: * <p>This method predates the general-purpose exception chaining facility.
101: * The {@link Throwable#getCause()} method is now the preferred means of
102: * obtaining this information.
103: *
104: * @return the undeclared checked exception that was thrown
105: */
106: public Throwable getUndeclaredThrowable() {
107: return undeclaredThrowable;
108: }
109:
110: /**
111: * Returns the the cause of this exception (the <code>Throwable</code>
112: * instance wrapped in this <code>UndeclaredThrowableException</code>,
113: * which may be <tt>null</tt>).
114: *
115: * @return the cause of this exception.
116: * @since 1.4
117: */
118: public Throwable getCause() {
119: return undeclaredThrowable;
120: }
121: }
|