1 /*

     2  * Copyright (c) 1996, 2004, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    25 

    26 package java.lang.reflect;

    27 

    28 /**

    29  * InvocationTargetException is a checked exception that wraps

    30  * an exception thrown by an invoked method or constructor.

    31  *

    32  * <p>As of release 1.4, this exception has been retrofitted to conform to

    33  * the general purpose exception-chaining mechanism.  The "target exception"

    34  * that is provided at construction time and accessed via the

    35  * {@link #getTargetException()} method is now known as the <i>cause</i>,

    36  * and may be accessed via the {@link Throwable#getCause()} method,

    37  * as well as the aforementioned "legacy method."

    38  *

    39  * @see Method

    40  * @see Constructor

    41  * @since 1.1

    42  */

    43 public class InvocationTargetException extends ReflectiveOperationException {

    44     /**

    45      * Use serialVersionUID from JDK 1.1.X for interoperability

    46      */

    47     private static final long serialVersionUID = 4085088731926701167L;

    48 

    49      /**

    50      * This field holds the target if the

    51      * InvocationTargetException(Throwable target) constructor was

    52      * used to instantiate the object

    53      *

    54      * @serial

    55      *

    56      */

    57     private Throwable target;

    58 

    59     /**

    60      * Constructs an {@code InvocationTargetException} with

    61      * {@code null} as the target exception.

    62      */

    63     protected InvocationTargetException() {

    64         super((Throwable)null);  // Disallow initCause

    65     }

    66 

    67     /**

    68      * Constructs a InvocationTargetException with a target exception.

    69      *

    70      * @param target the target exception

    71      */

    72     public InvocationTargetException(Throwable target) {

    73         super((Throwable)null);  // Disallow initCause

    74         this.target = target;

    75     }

    76 

    77     /**

    78      * Constructs a InvocationTargetException with a target exception

    79      * and a detail message.

    80      *

    81      * @param target the target exception

    82      * @param s      the detail message

    83      */

    84     public InvocationTargetException(Throwable target, String s) {

    85         super(s, null);  // Disallow initCause

    86         this.target = target;

    87     }

    88 

    89     /**

    90      * Get the thrown target exception.

    91      *

    92      * <p>This method predates the general-purpose exception chaining facility.

    93      * The {@link Throwable#getCause()} method is now the preferred means of

    94      * obtaining this information.

    95      *

    96      * @return the thrown target exception (cause of this exception).

    97      */

    98     public Throwable getTargetException() {

    99         return target;

   100     }

   101 

   102     /**

   103      * Returns the cause of this exception (the thrown target exception,

   104      * which may be {@code null}).

   105      *

   106      * @return  the cause of this exception.

   107      * @since   1.4

   108      */

   109     public Throwable getCause() {

   110         return target;

   111     }

   112 }