src/java.base/share/classes/java/lang/reflect/InvocationTargetException.java
author mchung
Mon, 17 Sep 2018 15:22:46 -0700
changeset 51772 5432cebf6627
parent 47216 71c04702a3d5
child 51779 1740b162dc0e
permissions -rw-r--r--
8210721: Replace legacy serial exception field with Throwable::cause Reviewed-by: dfuchs, lancea
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
51772
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
    28
import java.io.IOException;
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
    29
import java.io.ObjectInputStream;
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
    30
import java.io.ObjectOutputStream;
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
    31
import java.io.ObjectStreamField;
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
    32
import jdk.internal.misc.SharedSecrets;
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
    33
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * InvocationTargetException is a checked exception that wraps
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * an exception thrown by an invoked method or constructor.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * <p>As of release 1.4, this exception has been retrofitted to conform to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * the general purpose exception-chaining mechanism.  The "target exception"
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * that is provided at construction time and accessed via the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * {@link #getTargetException()} method is now known as the <i>cause</i>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * and may be accessed via the {@link Throwable#getCause()} method,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * as well as the aforementioned "legacy method."
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * @see Method
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * @see Constructor
45434
4582657c7260 8181082: class-level since tag issues in java.base & java.datatransfer module
mli
parents: 25859
diff changeset
    47
 * @since 1.1
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 */
3311
a219a6c036a6 6857789: (reflect) Create common superclass of reflective exceptions
darcy
parents: 2
diff changeset
    49
public class InvocationTargetException extends ReflectiveOperationException {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
     * Use serialVersionUID from JDK 1.1.X for interoperability
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
    private static final long serialVersionUID = 4085088731926701167L;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
     * Constructs an {@code InvocationTargetException} with
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
     * {@code null} as the target exception.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
    protected InvocationTargetException() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
        super((Throwable)null);  // Disallow initCause
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     * Constructs a InvocationTargetException with a target exception.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     * @param target the target exception
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
    public InvocationTargetException(Throwable target) {
51772
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
    69
        super(null, target);  // Disallow initCause
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
     * Constructs a InvocationTargetException with a target exception
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
     * and a detail message.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
     * @param target the target exception
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
     * @param s      the detail message
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
    public InvocationTargetException(Throwable target, String s) {
51772
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
    80
        super(s, target);  // Disallow initCause
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
     * Get the thrown target exception.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
     * <p>This method predates the general-purpose exception chaining facility.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
     * The {@link Throwable#getCause()} method is now the preferred means of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
     * obtaining this information.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
     * @return the thrown target exception (cause of this exception).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
    public Throwable getTargetException() {
51772
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
    93
        return super.getCause();
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
    /**
51772
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
    97
     * Serializable fields for UndeclaredThrowableException.
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
    98
     *
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
    99
     * @serialField target Throwable
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   100
     */
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   101
    private static final ObjectStreamField[] serialPersistentFields = {
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   102
        new ObjectStreamField("target", Throwable.class)
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   103
    };
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   104
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   105
    /*
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   106
     * Reconstitutes the InvocationTargetException instance from a stream
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   107
     * and initialize the cause properly when deserializing from an older
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   108
     * version.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
     *
51772
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   110
     * The getException and getCause method returns the private "target" field
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   111
     * in the older implementation and InvocationTargetException::cause
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   112
     * was set to null.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
     */
51772
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   114
    private void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException {
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   115
        ObjectInputStream.GetField fields = s.readFields();
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   116
        Throwable exception = (Throwable) fields.get("target", null);
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   117
        if (exception != null) {
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   118
            SharedSecrets.getJavaLangAccess().setCause(this, exception);
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   119
        }
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   120
    }
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   121
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   122
    /*
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   123
     * To maintain compatibility with older implementation, write a serial
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   124
     * "target" field with the cause as the value.
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   125
     */
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   126
    private void writeObject(ObjectOutputStream out) throws IOException {
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   127
        ObjectOutputStream.PutField fields = out.putFields();
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   128
        fields.put("target", super.getCause());
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 47216
diff changeset
   129
        out.writeFields();
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   131
}