src/java.base/share/classes/java/io/InvalidClassException.java
author darcy
Wed, 27 Nov 2019 06:36:41 -0800
changeset 59295 8b6cc0bb93d0
parent 57956 e0b8b019d2f5
permissions -rw-r--r--
8234781: Update description of InvalidClassException to include more conditions Reviewed-by: alanb, chegar
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) 1996, 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: 2
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: 2
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: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
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.io;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
 * Thrown when the Serialization runtime detects one of the following
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * problems with a Class.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * <UL>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * <LI> The serial version of the class does not match that of the class
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 *      descriptor read from the stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * <LI> The class contains unknown datatypes
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * <LI> The class does not have an accessible no-arg constructor
59295
8b6cc0bb93d0 8234781: Update description of InvalidClassException to include more conditions
darcy
parents: 57956
diff changeset
    36
 * <LI> The ObjectStreamClass of an enum constant does not represent
8b6cc0bb93d0 8234781: Update description of InvalidClassException to include more conditions
darcy
parents: 57956
diff changeset
    37
 *      an enum type
8b6cc0bb93d0 8234781: Update description of InvalidClassException to include more conditions
darcy
parents: 57956
diff changeset
    38
 * <LI> Other conditions given in the <cite>Java Object Serialization
8b6cc0bb93d0 8234781: Update description of InvalidClassException to include more conditions
darcy
parents: 57956
diff changeset
    39
 *      Specification</cite>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * </UL>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * @author  unascribed
24865
09b1d992ca72 8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents: 5506
diff changeset
    43
 * @since   1.1
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
public class InvalidClassException extends ObjectStreamException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
57956
e0b8b019d2f5 8229997: Apply java.io.Serial annotations in java.base
darcy
parents: 47216
diff changeset
    47
    @java.io.Serial
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
    private static final long serialVersionUID = -4333316296251054416L;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
     * Name of the invalid class.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
     * @serial Name of the invalid class.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
    public String classname;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
     * Report an InvalidClassException for the reason specified.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
     * @param reason  String describing the reason for the exception.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
    public InvalidClassException(String reason) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
        super(reason);
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 an InvalidClassException object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
     * @param cname   a String naming the invalid class.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
     * @param reason  a String describing the reason for the exception.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
    public InvalidClassException(String cname, String reason) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
        super(reason);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
        classname = cname;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
     * Produce the message and include the classname, if present.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
    public String getMessage() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
        if (classname == null)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
            return super.getMessage();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
        else
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
            return classname + "; " + super.getMessage();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
}