1 /*
  2  * Copyright (c) 1996, 2022, 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.io;
 27 
 28 /**
 29  * Thrown when the Serialization runtime detects one of the following
 30  * problems with a Class.
 31  * <UL>
 32  * <LI> The serial version of the class does not match that of the class
 33  *      descriptor read from the stream
 34  * <LI> The class contains unknown datatypes
 35  * <LI> The class does not have an accessible no-arg constructor
 36  * <LI> The ObjectStreamClass of an enum constant does not represent
 37  *      an enum type
 38  * <LI> Other conditions given in the <cite>Java Object Serialization
 39  *      Specification</cite>
 40  * <LI> A {@linkplain Class#isValue()} value class implements {@linkplain Serializable}
 41  *      but does not delegate to a serialization proxy using {@code writeReplace()}.
 42  * <LI> A {@linkplain Class#isValue()} value class implements {@linkplain Externalizable}.
 43  * </UL>
 44  *
 45  * @since   1.1
 46  */
 47 public class InvalidClassException extends ObjectStreamException {
 48 
 49     @java.io.Serial
 50     private static final long serialVersionUID = -4333316296251054416L;
 51 
 52     /**
 53      * Name of the invalid class.
 54      *
 55      * @serial Name of the invalid class.
 56      */
 57     public String classname;
 58 
 59     /**
 60      * Report an InvalidClassException for the reason specified.
 61      *
 62      * @param reason  String describing the reason for the exception.
 63      */
 64     public InvalidClassException(String reason) {
 65         super(reason);
 66     }
 67 
 68     /**
 69      * Constructs an InvalidClassException object.
 70      *
 71      * @param cname   a String naming the invalid class.
 72      * @param reason  a String describing the reason for the exception.
 73      */
 74     public InvalidClassException(String cname, String reason) {
 75         super(reason);
 76         classname = cname;
 77     }
 78 
 79     /**
 80      * Report an InvalidClassException for the reason and cause specified.
 81      *
 82      * @param reason  String describing the reason for the exception.
 83      * @param cause the cause
 84      * @since 19
 85      */
 86     public InvalidClassException(String reason, Throwable cause) {
 87         super(reason, cause);
 88     }
 89 
 90     /**
 91      * Report an InvalidClassException for the reason and cause specified.
 92      *
 93      * @param cname   a String naming the invalid class.
 94      * @param reason  String describing the reason for the exception.
 95      * @param cause the cause
 96      * @since 19
 97      */
 98     public InvalidClassException(String cname, String reason, Throwable cause) {
 99         super(reason, cause);
100         classname = cname;
101     }
102 
103     /**
104      * Produce the message and include the classname, if present.
105      */
106     @Override
107     public String getMessage() {
108         if (classname == null)
109             return super.getMessage();
110         else
111             return classname + "; " + super.getMessage();
112     }
113 }