libjava/java/io/InvalidClassException.java

   1 /* InvalidClassException.java -- deserializing a class failed
   2    Copyright (C) 1998, 2002 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package java.io;
  40
  41 /**
  42  * This exception is thrown when there is some sort of problem with a
  43  * class during a serialization operation.  This could be:<br><ul>
  44  * <li>the serial version of the class doesn't match</li>
  45  * <li>the class contains unknown datatypes</li>
  46  * <li>the class does not have an accessible no-arg constructor</li>
  47  * </ul>.
  48  *
  49  * <p>The field <code>classname</code> will contain the name of the
  50  * class that caused the problem if known.  The getMessage() method
  51  * for this exception will always include the name of that class
  52  * if known.
  53  *
  54  * @author Aaron M. Renn (arenn@urbanophile.com)
  55  * @since 1.1
  56  * @status updated to 1.4
  57  */
  58 public class InvalidClassException extends ObjectStreamException
  59 {
  60   /**
  61    * Compatible with JDK 1.1+.
  62    */
  63   private static final long serialVersionUID = -4333316296251054416L;
  64
  65   /**
  66    * The name of the class which encountered the error.
  67    *
  68    * @serial the classname causing the error
  69    */
  70   public String classname;
  71
  72   /**
  73    * Create an exception with a descriptive error message, but a null
  74    * classname.
  75    *
  76    * @param message the descriptive error message
  77    */
  78   public InvalidClassException(String message)
  79   {
  80     super(message);
  81   }
  82
  83   /**
  84    * Create an exception with a descriptive error message, and the name of
  85    * the class that caused the problem.
  86    *
  87    * @param classname the name of the faulty class
  88    * @param message the descriptive error message
  89    */
  90   public InvalidClassException(String classname, String message)
  91   {
  92     super(message);
  93     this.classname = classname;
  94   }
  95
  96   /**
  97    * Returns the descriptive error message for this exception. It will
  98    * include the class name that caused the problem if known, in the format:
  99    * <code>[classname][; ][super.getMessage()]</code>.
 100    *
 101    * @return A descriptive error message, may be null
 102    */
 103   public String getMessage()
 104   {
 105     String msg = super.getMessage();
 106     if (msg == null)
 107       return classname;
 108     return (classname == null ? "" : classname + "; ") + msg;
 109   }
 110 }
 111