01 /*
02 * Copyright 1996-2005 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25 package java.io;
26
27 /**
28 * Exception indicating the failure of an object read operation due to
29 * unread primitive data, or the end of data belonging to a serialized
30 * object in the stream. This exception may be thrown in two cases:
31 *
32 * <ul>
33 * <li>An attempt was made to read an object when the next element in the
34 * stream is primitive data. In this case, the OptionalDataException's
35 * length field is set to the number of bytes of primitive data
36 * immediately readable from the stream, and the eof field is set to
37 * false.
38 *
39 * <li>An attempt was made to read past the end of data consumable by a
40 * class-defined readObject or readExternal method. In this case, the
41 * OptionalDataException's eof field is set to true, and the length field
42 * is set to 0.
43 * </ul>
44 *
45 * @author unascribed
46 * @version 1.29, 05/05/07
47 * @since JDK1.1
48 */
49 public class OptionalDataException extends ObjectStreamException {
50
51 private static final long serialVersionUID = -8011121865681257820L;
52
53 /*
54 * Create an <code>OptionalDataException</code> with a length.
55 */
56 OptionalDataException(int len) {
57 eof = false;
58 length = len;
59 }
60
61 /*
62 * Create an <code>OptionalDataException</code> signifying no
63 * more primitive data is available.
64 */
65 OptionalDataException(boolean end) {
66 length = 0;
67 eof = end;
68 }
69
70 /**
71 * The number of bytes of primitive data available to be read
72 * in the current buffer.
73 *
74 * @serial
75 */
76 public int length;
77
78 /**
79 * True if there is no more data in the buffered part of the stream.
80 *
81 * @serial
82 */
83 public boolean eof;
84 }
|