/* OptionalDataException.java -- indicates unexpected data in serialised stream
   Copyright (C) 1998, 2000, 2001 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
 
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA.

As a special exception, if you link this library with other files to
produce an executable, this library does not by itself cause the
resulting executable to be covered by the GNU General Public License.
This exception does not however invalidate any other reasons why the
executable file might be covered by the GNU General Public License. */


package java.io;

/* Written using on-line Java Platform 1.2 API Specification.
 * Status:  Believed complete and correct.
 */

/**
  * This exception is thrown when unexpected data appears in the input
  * stream from which a serialized object is being read.  The field
  * <code>eof</code> will always be set to true (***Why even have it?***) and 
  * the <code>count</code> field will contain the number of valid bytes
  * available to be read.
  *
  * @version 0.0
  *
  * @author Aaron M. Renn (arenn@urbanophile.com)
  * @author Warren Levy <warrenl@cygnus.com>
  * @date February 7, 2000. 
  */
public class OptionalDataException extends ObjectStreamException
{

private static final long serialVersionUID = -8011121865681257820L;

/*
 * Instance Variables
 */

/**
  * Whether or not the end of the stream has been reached
  */
public boolean eof;

/**
  * The number of valid bytes that can be read
  */
public int length;

/*************************************************************************/

/*
 * Constructors
 */

/**
  * Create a new OptionalDataException with an eof parameter indicating
  * whether or not the end of stream is reached and the number of valid
  * bytes that may be read.
  *
  * @param eof 'true' if end of stream reached, 'false' otherwise
  * @param count The number of valid bytes to be read.
  */
OptionalDataException(boolean eof, int count)
{
  this.eof = eof;
  this.length = count;
}

} // class OptionalDataException