1 /*
  2  * Copyright (c) 1996, 2026, 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>The class declares or inherits any strictly-initialized instance field
 39  * <li>A {@linkplain Class#isValue value class} cannot be serialized
 40  * <li> Other conditions given in the <cite>Java Object Serialization
 41  *      Specification</cite>
 42  * </ul>
 43  *
 44  * @since   1.1
 45  */
 46 public class InvalidClassException extends ObjectStreamException {
 47 
 48     @java.io.Serial
 49     private static final long serialVersionUID = -4333316296251054416L;
 50 
 51     /**
 52      * Name of the invalid class.
 53      *
 54      * @serial Name of the invalid class.
 55      */
 56     public String classname;
 57 
 58     /**
 59      * Report an InvalidClassException for the reason specified.
 60      *
 61      * @param reason  String describing the reason for the exception.
 62      */
 63     public InvalidClassException(String reason) {
 64         super(reason);
 65     }
 66 
 67     /**
 68      * Constructs an InvalidClassException object.
 69      *
 70      * @param cname   a String naming the invalid class.
 71      * @param reason  a String describing the reason for the exception.
 72      */
 73     public InvalidClassException(String cname, String reason) {
 74         super(reason);
 75         classname = cname;
 76     }
 77 
 78     /**
 79      * Report an InvalidClassException for the reason and cause specified.
 80      *
 81      * @param reason  String describing the reason for the exception.
 82      * @param cause the cause
 83      * @since 19
 84      */
 85     public InvalidClassException(String reason, Throwable cause) {
 86         super(reason, cause);
 87     }
 88 
 89     /**
 90      * Report an InvalidClassException for the reason and cause specified.
 91      *
 92      * @param cname   a String naming the invalid class.
 93      * @param reason  String describing the reason for the exception.
 94      * @param cause the cause
 95      * @since 19
 96      */
 97     public InvalidClassException(String cname, String reason, Throwable cause) {
 98         super(reason, cause);
 99         classname = cname;
100     }
101 
102     /**
103      * Produce the message and include the classname, if present.
104      */
105     @Override
106     public String getMessage() {
107         if (classname == null)
108             return super.getMessage();
109         else
110             return classname + "; " + super.getMessage();
111     }
112 }