001 /* OptionalDataException.java -- indicates unexpected data in serialized stream
002 Copyright (C) 1998, 2000, 2001, 2002, 2005 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package java.io;
040
041 /**
042 * This exception is thrown when unexpected data appears in the input
043 * stream from which a serialized object is being read. There are two
044 * cases:<br><ul>
045 * <li>The next stream element is primitive data. <code>eof</code> will
046 * be false, and <code>count</code> is the number of bytes of primitive
047 * data available.</li>
048 * <li>The data consumable by readObject or readExternal has been exhausted.
049 * <code>eof</code> is true, and <code>count</code> is 0.</li>
050 * </ul>
051 *
052 * @author Aaron M. Renn (arenn@urbanophile.com)
053 * @author Warren Levy (warrenl@cygnus.com)
054 * @since 1.1
055 * @status updated to 1.4
056 */
057 public class OptionalDataException extends ObjectStreamException
058 {
059 /**
060 * Compatible with JDK 1.1+.
061 */
062 private static final long serialVersionUID = -8011121865681257820L;
063
064 /**
065 * Whether or not the end of the stream has been reached.
066 *
067 * @serial the end of the buffer was reached
068 */
069 public boolean eof;
070
071 /**
072 * The number of valid bytes that can be read.
073 *
074 * @serial the bytes of the buffer remaining
075 */
076 public int length;
077
078 /**
079 * Create a new OptionalDataException with an eof parameter indicating
080 * whether or not the end of stream is reached and the number of valid
081 * bytes that may be read.
082 *
083 * @param eof 'true' if end of stream reached, 'false' otherwise
084 * @param count The number of valid bytes to be read
085 */
086 OptionalDataException(boolean eof, int count)
087 {
088 this.eof = eof;
089 this.length = count;
090 }
091 } // class OptionalDataException