libjava/java/lang/reflect/UndeclaredThrowableException.java

   1 /* UndeclaredThrowableException.java -- wraps an undeclared checked exception
   2    thrown by a Proxy invocation handler
   3    Copyright (C) 2001, 2002, 2005  Free Software Foundation, Inc.
   4
   5 This file is part of GNU Classpath.
   6
   7 GNU Classpath is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2, or (at your option)
  10 any later version.
  11
  12 GNU Classpath is distributed in the hope that it will be useful, but
  13 WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU Classpath; see the file COPYING.  If not, write to the
  19 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  20 02111-1307 USA.
  21
  22 Linking this library statically or dynamically with other modules is
  23 making a combined work based on this library.  Thus, the terms and
  24 conditions of the GNU General Public License cover the whole
  25 combination.
  26
  27 As a special exception, the copyright holders of this library give you
  28 permission to link this library with independent modules to produce an
  29 executable, regardless of the license terms of these independent
  30 modules, and to copy and distribute the resulting executable under
  31 terms of your choice, provided that you also meet, for each linked
  32 independent module, the terms and conditions of the license of that
  33 module.  An independent module is a module which is not derived from
  34 or based on this library.  If you modify this library, you may extend
  35 this exception to your version of the library, but you are not
  36 obligated to do so.  If you do not wish to do so, delete this
  37 exception statement from your version. */
  38
  39
  40 package java.lang.reflect;
  41
  42 /**
  43  * This exception class is thrown by a {@link Proxy} instance if
  44  * the {@link InvocationHandler#invoke(Object, Method, Object[]) invoke}
  45  * method of that instance's InvocationHandler attempts to throw an
  46  * exception that not declared by the throws clauses of all of the
  47  * interface methods that the proxy instance is implementing.
  48  *
  49  * <p>When thrown by Proxy, this class will always wrap a checked
  50  * exception, never {@link Error} or {@link RuntimeException},
  51  * which are unchecked.
  52  *
  53  * @author Eric Blake (ebb9@email.byu.edu)
  54  * @see Proxy
  55  * @see InvocationHandler
  56  * @since 1.3
  57  * @status updated to 1.4
  58  */
  59 public class UndeclaredThrowableException extends RuntimeException
  60 {
  61   /**
  62    * Compatible with JDK 1.3+.
  63    */
  64   private static final long serialVersionUID = 330127114055056639L;
  65
  66   /**
  67    * The immutable exception that this wraps. This field is redundant
  68    * with {@link Throwable#cause}, but is necessary for serial compatibility.
  69    *
  70    * @serial the chained exception
  71    */
  72   private final Throwable undeclaredThrowable;
  73
  74   /**
  75    * Wraps the given checked exception into a RuntimeException, with no
  76    * detail message.  {@link Throwable#initCause(Throwable)} will fail
  77    * on this instance.
  78    *
  79    * @param cause the undeclared throwable that caused this exception,
  80    *        may be null
  81    */
  82   public UndeclaredThrowableException(Throwable cause)
  83   {
  84     this(cause, null);
  85   }
  86
  87   /**
  88    * Wraps the given checked exception into a RuntimeException, with the
  89    * specified detail message.  {@link Throwable#initCause(Throwable)} will
  90    * fail on this instance.
  91    *
  92    * @param cause the undeclared throwable that caused this exception,
  93    *        may be null
  94    * @param message the message, may be null
  95    */
  96   public UndeclaredThrowableException(Throwable cause, String message)
  97   {
  98     super(message, cause);
  99     undeclaredThrowable = cause;
 100   }
 101
 102   /**
 103    * Returns the cause of this exception.  If this exception was created
 104    * by a {@link Proxy} instance, it will be a non-null checked
 105    * exception.  This method pre-dates exception chaining, and is now
 106    * simply a longer way to call <code>getCause()</code>.
 107    *
 108    * @return the cause of this exception, may be null
 109    * @see #getCause()
 110    */
 111   public Throwable getUndeclaredThrowable()
 112   {
 113     return undeclaredThrowable;
 114   }
 115
 116   /**
 117    * Returns the cause of this exception.  If this exception was created
 118    * by a {@link Proxy} instance, it will be a non-null checked
 119    * exception.
 120    *
 121    * @return the cause of this exception, may be null
 122    * @since 1.4
 123    */
 124   public Throwable getCause()
 125   {
 126     return undeclaredThrowable;
 127   }
 128 }