/*

 * Copyright (c) 1996, 2019, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code 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

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package java.io;

/**

 * Exception indicating the failure of an object read operation due to

 * unread primitive data, or the end of data belonging to a serialized

 * object in the stream.  This exception may be thrown in two cases:

 *

 * <ul>

 *   <li>An attempt was made to read an object when the next element in the

 *       stream is primitive data.  In this case, the OptionalDataException's

 *       length field is set to the number of bytes of primitive data

 *       immediately readable from the stream, and the eof field is set to

 *       false.

 *

 *   <li>An attempt was made to read past the end of data consumable by a

 *       class-defined readObject or readExternal method.  In this case, the

 *       OptionalDataException's eof field is set to true, and the length field

 *       is set to 0.

 * </ul>

 *

 * @author  unascribed

 * @since   1.1

 */

public class OptionalDataException extends ObjectStreamException {

    @java.io.Serial

    private static final long serialVersionUID = -8011121865681257820L;

    /*

     * Create an {@code OptionalDataException} with a length.

     */

    OptionalDataException(int len) {

        eof = false;

        length = len;

    }

    /*

     * Create an {@code OptionalDataException} signifying no

     * more primitive data is available.

     */

    OptionalDataException(boolean end) {

        length = 0;

        eof = end;

    }

    /**

     * The number of bytes of primitive data available to be read

     * in the current buffer.

     *

     * @serial

     */

    public int length;

    /**

     * True if there is no more data in the buffered part of the stream.

     *

     * @serial

     */

    public boolean eof;

}