libjava/java/io/OptionalDataException.java

   1 /* OptionalDataException.java -- indicates unexpected data in serialized stream
   2    Copyright (C) 1998, 2000, 2001, 2002, 2005  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 unexpected data appears in the input
  43  * stream from which a serialized object is being read. There are two
  44  * cases:<br><ul>
  45  * <li>The next stream element is primitive data. <code>eof</code> will
  46  *     be false, and <code>count</code> is the number of bytes of primitive
  47  *     data available.</li>
  48  * <li>The data consumable by readObject or readExternal has been exhausted.
  49  *     <code>eof</code> is true, and <code>count</code> is 0.</li>
  50  * </ul>
  51  *
  52  * @author Aaron M. Renn (arenn@urbanophile.com)
  53  * @author Warren Levy (warrenl@cygnus.com)
  54  * @since 1.1
  55  * @status updated to 1.4
  56  */
  57 public class OptionalDataException extends ObjectStreamException
  58 {
  59   /**
  60    * Compatible with JDK 1.1+.
  61    */
  62   private static final long serialVersionUID = -8011121865681257820L;
  63
  64   /**
  65    * Whether or not the end of the stream has been reached.
  66    *
  67    * @serial the end of the buffer was reached
  68    */
  69   public boolean eof;
  70
  71   /**
  72    * The number of valid bytes that can be read.
  73    *
  74    * @serial the bytes of the buffer remaining
  75    */
  76   public int length;
  77
  78   /**
  79    * Create a new OptionalDataException with an eof parameter indicating
  80    * whether or not the end of stream is reached and the number of valid
  81    * bytes that may be read.
  82    *
  83    * @param eof 'true' if end of stream reached, 'false' otherwise
  84    * @param count The number of valid bytes to be read
  85    */
  86   OptionalDataException(boolean eof, int count)
  87   {
  88     this.eof = eof;
  89     this.length = count;
  90   }
  91 } // class OptionalDataException