jaroslav@601: /*
jaroslav@601:  * Copyright (c) 1996, 2005, Oracle and/or its affiliates. All rights reserved.
jaroslav@601:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
jaroslav@601:  *
jaroslav@601:  * This code is free software; you can redistribute it and/or modify it
jaroslav@601:  * under the terms of the GNU General Public License version 2 only, as
jaroslav@601:  * published by the Free Software Foundation.  Oracle designates this
jaroslav@601:  * particular file as subject to the "Classpath" exception as provided
jaroslav@601:  * by Oracle in the LICENSE file that accompanied this code.
jaroslav@601:  *
jaroslav@601:  * This code is distributed in the hope that it will be useful, but WITHOUT
jaroslav@601:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
jaroslav@601:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
jaroslav@601:  * version 2 for more details (a copy is included in the LICENSE file that
jaroslav@601:  * accompanied this code).
jaroslav@601:  *
jaroslav@601:  * You should have received a copy of the GNU General Public License version
jaroslav@601:  * 2 along with this work; if not, write to the Free Software Foundation,
jaroslav@601:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
jaroslav@601:  *
jaroslav@601:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
jaroslav@601:  * or visit www.oracle.com if you need additional information or have any
jaroslav@601:  * questions.
jaroslav@601:  */
jaroslav@601: package java.io;
jaroslav@601: 
jaroslav@601: /**
jaroslav@601:  * Exception indicating the failure of an object read operation due to
jaroslav@601:  * unread primitive data, or the end of data belonging to a serialized
jaroslav@601:  * object in the stream.  This exception may be thrown in two cases:
jaroslav@601:  *
jaroslav@601:  * <ul>
jaroslav@601:  *   <li>An attempt was made to read an object when the next element in the
jaroslav@601:  *       stream is primitive data.  In this case, the OptionalDataException's
jaroslav@601:  *       length field is set to the number of bytes of primitive data
jaroslav@601:  *       immediately readable from the stream, and the eof field is set to
jaroslav@601:  *       false.
jaroslav@601:  *
jaroslav@601:  *   <li>An attempt was made to read past the end of data consumable by a
jaroslav@601:  *       class-defined readObject or readExternal method.  In this case, the
jaroslav@601:  *       OptionalDataException's eof field is set to true, and the length field
jaroslav@601:  *       is set to 0.
jaroslav@601:  * </ul>
jaroslav@601:  *
jaroslav@601:  * @author  unascribed
jaroslav@601:  * @since   JDK1.1
jaroslav@601:  */
jaroslav@601: public class OptionalDataException extends ObjectStreamException {
jaroslav@601: 
jaroslav@601:     private static final long serialVersionUID = -8011121865681257820L;
jaroslav@601: 
jaroslav@601:     /*
jaroslav@601:      * Create an <code>OptionalDataException</code> with a length.
jaroslav@601:      */
jaroslav@601:     OptionalDataException(int len) {
jaroslav@601:         eof = false;
jaroslav@601:         length = len;
jaroslav@601:     }
jaroslav@601: 
jaroslav@601:     /*
jaroslav@601:      * Create an <code>OptionalDataException</code> signifying no
jaroslav@601:      * more primitive data is available.
jaroslav@601:      */
jaroslav@601:     OptionalDataException(boolean end) {
jaroslav@601:         length = 0;
jaroslav@601:         eof = end;
jaroslav@601:     }
jaroslav@601: 
jaroslav@601:     /**
jaroslav@601:      * The number of bytes of primitive data available to be read
jaroslav@601:      * in the current buffer.
jaroslav@601:      *
jaroslav@601:      * @serial
jaroslav@601:      */
jaroslav@601:     public int length;
jaroslav@601: 
jaroslav@601:     /**
jaroslav@601:      * True if there is no more data in the buffered part of the stream.
jaroslav@601:      *
jaroslav@601:      * @serial
jaroslav@601:      */
jaroslav@601:     public boolean eof;
jaroslav@601: }