src/java.base/share/classes/java/lang/Error.java
author darcy
Thu, 29 Aug 2019 16:31:34 -0700
changeset 57956 e0b8b019d2f5
parent 47216 71c04702a3d5
permissions -rw-r--r--
8229997: Apply java.io.Serial annotations in java.base Reviewed-by: alanb, rriggs
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
57956
e0b8b019d2f5 8229997: Apply java.io.Serial annotations in java.base
darcy
parents: 47216
diff changeset
     2
 * Copyright (c) 1995, 2019, 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: 4666
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: 4666
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: 4666
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4666
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4666
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;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
4666
085aef3c09ff 6915171: Clarify checked/unchecked status of Throwable and its subclasses
darcy
parents: 2
diff changeset
    29
 * An {@code Error} is a subclass of {@code Throwable}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * that indicates serious problems that a reasonable application
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * should not try to catch. Most such errors are abnormal conditions.
4666
085aef3c09ff 6915171: Clarify checked/unchecked status of Throwable and its subclasses
darcy
parents: 2
diff changeset
    32
 * The {@code ThreadDeath} error, though a "normal" condition,
085aef3c09ff 6915171: Clarify checked/unchecked status of Throwable and its subclasses
darcy
parents: 2
diff changeset
    33
 * is also a subclass of {@code Error} because most applications
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * should not try to catch it.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * <p>
4666
085aef3c09ff 6915171: Clarify checked/unchecked status of Throwable and its subclasses
darcy
parents: 2
diff changeset
    36
 * A method is not required to declare in its {@code throws}
085aef3c09ff 6915171: Clarify checked/unchecked status of Throwable and its subclasses
darcy
parents: 2
diff changeset
    37
 * clause any subclasses of {@code Error} that might be thrown
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * during the execution of the method but not caught, since these
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * errors are abnormal conditions that should never occur.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 *
4666
085aef3c09ff 6915171: Clarify checked/unchecked status of Throwable and its subclasses
darcy
parents: 2
diff changeset
    41
 * That is, {@code Error} and its subclasses are regarded as unchecked
085aef3c09ff 6915171: Clarify checked/unchecked status of Throwable and its subclasses
darcy
parents: 2
diff changeset
    42
 * exceptions for the purposes of compile-time checking of exceptions.
085aef3c09ff 6915171: Clarify checked/unchecked status of Throwable and its subclasses
darcy
parents: 2
diff changeset
    43
 *
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * @author  Frank Yellin
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * @see     java.lang.ThreadDeath
9266
121fb370f179 7032960: API files in java.awt need to be updated for references to JVM Spec with editions/hyperlinks
jjh
parents: 7668
diff changeset
    46
 * @jls 11.2 Compile-Time Checking of Exceptions
24865
09b1d992ca72 8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents: 9513
diff changeset
    47
 * @since   1.0
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
public class Error extends Throwable {
57956
e0b8b019d2f5 8229997: Apply java.io.Serial annotations in java.base
darcy
parents: 47216
diff changeset
    50
    @java.io.Serial
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
    static final long serialVersionUID = 4980196508277280342L;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
    /**
4666
085aef3c09ff 6915171: Clarify checked/unchecked status of Throwable and its subclasses
darcy
parents: 2
diff changeset
    54
     * Constructs a new error with {@code null} as its detail message.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
     * The cause is not initialized, and may subsequently be initialized by a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
     * call to {@link #initCause}.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
    public Error() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
        super();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
     * Constructs a new error with the specified detail message.  The
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     * cause is not initialized, and may subsequently be initialized by
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     * a call to {@link #initCause}.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
     * @param   message   the detail message. The detail message is saved for
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
     *          later retrieval by the {@link #getMessage()} method.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
    public Error(String message) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
        super(message);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
     * Constructs a new error with the specified detail message and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
     * cause.  <p>Note that the detail message associated with
4666
085aef3c09ff 6915171: Clarify checked/unchecked status of Throwable and its subclasses
darcy
parents: 2
diff changeset
    77
     * {@code cause} is <i>not</i> automatically incorporated in
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
     * this error's detail message.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
     * @param  message the detail message (which is saved for later retrieval
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
     *         by the {@link #getMessage()} method).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
     * @param  cause the cause (which is saved for later retrieval by the
9513
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
    83
     *         {@link #getCause()} method).  (A {@code null} value is
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
     *         permitted, and indicates that the cause is nonexistent or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
     *         unknown.)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
     * @since  1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
    public Error(String message, Throwable cause) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
        super(message, cause);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
     * Constructs a new error with the specified cause and a detail
9513
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
    94
     * message of {@code (cause==null ? null : cause.toString())} (which
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
    95
     * typically contains the class and detail message of {@code cause}).
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
     * This constructor is useful for errors that are little more than
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
     * wrappers for other throwables.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
     * @param  cause the cause (which is saved for later retrieval by the
9513
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   100
     *         {@link #getCause()} method).  (A {@code null} value is
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
     *         permitted, and indicates that the cause is nonexistent or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
     *         unknown.)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
     * @since  1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
    public Error(Throwable cause) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
        super(cause);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
    }
9513
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   108
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   109
    /**
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   110
     * Constructs a new error with the specified detail message,
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   111
     * cause, suppression enabled or disabled, and writable stack
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   112
     * trace enabled or disabled.
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   113
     *
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   114
     * @param  message the detail message.
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   115
     * @param cause the cause.  (A {@code null} value is permitted,
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   116
     * and indicates that the cause is nonexistent or unknown.)
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   117
     * @param enableSuppression whether or not suppression is enabled
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   118
     *                          or disabled
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   119
     * @param writableStackTrace whether or not the stack trace should
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   120
     *                           be writable
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   121
     *
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   122
     * @since 1.7
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   123
     */
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   124
    protected Error(String message, Throwable cause,
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   125
                    boolean enableSuppression,
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   126
                    boolean writableStackTrace) {
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   127
        super(message, cause, enableSuppression, writableStackTrace);
1079ae7ada52 6998871: Support making the Throwable.stackTrace field immutable
darcy
parents: 9266
diff changeset
   128
    }
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
}