rt/emul/compact/src/main/java/java/io/OptionalDataException.java
changeset 772 d382dacfd73f
parent 601 5198affdb915
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/rt/emul/compact/src/main/java/java/io/OptionalDataException.java	Tue Feb 26 16:54:16 2013 +0100
     1.3 @@ -0,0 +1,83 @@
     1.4 +/*
     1.5 + * Copyright (c) 1996, 2005, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +package java.io;
    1.29 +
    1.30 +/**
    1.31 + * Exception indicating the failure of an object read operation due to
    1.32 + * unread primitive data, or the end of data belonging to a serialized
    1.33 + * object in the stream.  This exception may be thrown in two cases:
    1.34 + *
    1.35 + * <ul>
    1.36 + *   <li>An attempt was made to read an object when the next element in the
    1.37 + *       stream is primitive data.  In this case, the OptionalDataException's
    1.38 + *       length field is set to the number of bytes of primitive data
    1.39 + *       immediately readable from the stream, and the eof field is set to
    1.40 + *       false.
    1.41 + *
    1.42 + *   <li>An attempt was made to read past the end of data consumable by a
    1.43 + *       class-defined readObject or readExternal method.  In this case, the
    1.44 + *       OptionalDataException's eof field is set to true, and the length field
    1.45 + *       is set to 0.
    1.46 + * </ul>
    1.47 + *
    1.48 + * @author  unascribed
    1.49 + * @since   JDK1.1
    1.50 + */
    1.51 +public class OptionalDataException extends ObjectStreamException {
    1.52 +
    1.53 +    private static final long serialVersionUID = -8011121865681257820L;
    1.54 +
    1.55 +    /*
    1.56 +     * Create an <code>OptionalDataException</code> with a length.
    1.57 +     */
    1.58 +    OptionalDataException(int len) {
    1.59 +        eof = false;
    1.60 +        length = len;
    1.61 +    }
    1.62 +
    1.63 +    /*
    1.64 +     * Create an <code>OptionalDataException</code> signifying no
    1.65 +     * more primitive data is available.
    1.66 +     */
    1.67 +    OptionalDataException(boolean end) {
    1.68 +        length = 0;
    1.69 +        eof = end;
    1.70 +    }
    1.71 +
    1.72 +    /**
    1.73 +     * The number of bytes of primitive data available to be read
    1.74 +     * in the current buffer.
    1.75 +     *
    1.76 +     * @serial
    1.77 +     */
    1.78 +    public int length;
    1.79 +
    1.80 +    /**
    1.81 +     * True if there is no more data in the buffered part of the stream.
    1.82 +     *
    1.83 +     * @serial
    1.84 +     */
    1.85 +    public boolean eof;
    1.86 +}