jdk/src/share/classes/java/lang/reflect/InvocationTargetException.java
author robm
Wed, 23 Jan 2013 17:54:34 +0000
changeset 15294 df55735ea03c
parent 5506 202f599c92aa
permissions -rw-r--r--
8004729: Add java.lang.reflect.Parameter and related changes for parameter reflection Reviewed-by: darcy, forax, psandoz, dholmes, tbell
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 3311
diff changeset
     2
 * Copyright (c) 1996, 2004, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 3311
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 3311
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 3311
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 3311
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 3311
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.lang.reflect;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
 * InvocationTargetException is a checked exception that wraps
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * an exception thrown by an invoked method or constructor.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * <p>As of release 1.4, this exception has been retrofitted to conform to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * the general purpose exception-chaining mechanism.  The "target exception"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * that is provided at construction time and accessed via the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * {@link #getTargetException()} method is now known as the <i>cause</i>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * and may be accessed via the {@link Throwable#getCause()} method,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * as well as the aforementioned "legacy method."
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * @see Method
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * @see Constructor
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 */
3311
a219a6c036a6 6857789: (reflect) Create common superclass of reflective exceptions
darcy
parents: 2
diff changeset
    42
public class InvocationTargetException extends ReflectiveOperationException {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
     * Use serialVersionUID from JDK 1.1.X for interoperability
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
    private static final long serialVersionUID = 4085088731926701167L;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
     /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
     * This field holds the target if the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
     * InvocationTargetException(Throwable target) constructor was
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
     * used to instantiate the object
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
     * @serial
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
    private Throwable target;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
     * Constructs an {@code InvocationTargetException} with
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
     * {@code null} as the target exception.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
    protected InvocationTargetException() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
        super((Throwable)null);  // Disallow initCause
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
     * Constructs a InvocationTargetException with a target exception.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
     * @param target the target exception
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
    public InvocationTargetException(Throwable target) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
        super((Throwable)null);  // Disallow initCause
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
        this.target = target;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
     * Constructs a InvocationTargetException with a target exception
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
     * and a detail message.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
     * @param target the target exception
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
     * @param s      the detail message
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
    public InvocationTargetException(Throwable target, String s) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
        super(s, null);  // Disallow initCause
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
        this.target = target;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
     * Get the thrown target exception.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
     * <p>This method predates the general-purpose exception chaining facility.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
     * The {@link Throwable#getCause()} method is now the preferred means of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
     * obtaining this information.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
     * @return the thrown target exception (cause of this exception).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
    public Throwable getTargetException() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
        return target;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
     * Returns the cause of this exception (the thrown target exception,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
     * which may be {@code null}).
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
     * @return  the cause of this exception.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
     * @since   1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
    public Throwable getCause() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
        return target;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
}