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  * </UL>
 41  *
 42  * @since   1.1
 43  */
 44 public class InvalidClassException extends ObjectStreamException {
 45 
 46     @java.io.Serial
 47     private static final long serialVersionUID = -4333316296251054416L;
 48 
 49     /**
 50      * Name of the invalid class.
 51      *
 52      * @serial Name of the invalid class.
 53      */
 54     public String classname;
 55 
 56     /**
 57      * Report an InvalidClassException for the reason specified.
 58      *
 59      * @param reason  String describing the reason for the exception.
 60      */
 61     public InvalidClassException(String reason) {
 62         super(reason);
 63     }
 64 
 65     /**
 66      * Constructs an InvalidClassException object.
 67      *
 68      * @param cname   a String naming the invalid class.
 69      * @param reason  a String describing the reason for the exception.
 70      */
 71     public InvalidClassException(String cname, String reason) {
 72         super(reason);
 73         classname = cname;
 74     }
 75 
 76     /**
 77      * Report an InvalidClassException for the reason and cause specified.
 78      *
 79      * @param reason  String describing the reason for the exception.
 80      * @param cause the cause
 81      * @since 19
 82      */
 83     public InvalidClassException(String reason, Throwable cause) {
 84         super(reason, cause);
 85     }
 86 
 87     /**
 88      * Report an InvalidClassException for the reason and cause specified.
 89      *
 90      * @param cname   a String naming the invalid class.
 91      * @param reason  String describing the reason for the exception.
 92      * @param cause the cause
 93      * @since 19
 94      */
 95     public InvalidClassException(String cname, String reason, Throwable cause) {
 96         super(reason, cause);
 97         classname = cname;
 98     }
 99 
100     /**
101      * Produce the message and include the classname, if present.
102      */
103     @Override
104     public String getMessage() {
105         if (classname == null)
106             return super.getMessage();
107         else
108             return classname + "; " + super.getMessage();
109     }
110 }