1 /*
2 * Copyright 1996-2005 Sun Microsystems, Inc. All Rights Reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * 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 * @since JDK1.1
47 */
48 public class OptionalDataException extends ObjectStreamException {
49
50 private static final long serialVersionUID = -8011121865681257820L;
51
52 /*
53 * Create an <code>OptionalDataException</code> with a length.
54 */
55 OptionalDataException(int len) {
56 eof = false;
57 length = len;
58 }
59
60 /*
61 * Create an <code>OptionalDataException</code> signifying no
62 * more primitive data is available.
63 */
64 OptionalDataException(boolean end) {
65 length = 0;
66 eof = end;
67 }
68
69 /**
70 * The number of bytes of primitive data available to be read
71 * in the current buffer.
72 *
73 * @serial
74 */
75 public int length;
76
77 /**
78 * True if there is no more data in the buffered part of the stream.
79 *
80 * @serial
81 */
82 public boolean eof;
83 }
Save This Page