author | erikj |
Tue, 12 Sep 2017 19:03:39 +0200 | |
changeset 47216 | 71c04702a3d5 |
parent 25859 | jdk/src/java.base/share/classes/java/io/OptionalDataException.java@3317bb8137f4 |
child 57956 | e0b8b019d2f5 |
child 58678 | 9cf78a70fa4f |
permissions | -rw-r--r-- |
2 | 1 |
/* |
5506 | 2 |
* Copyright (c) 1996, 2005, Oracle and/or its affiliates. All rights reserved. |
2 | 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 |
|
5506 | 7 |
* published by the Free Software Foundation. Oracle designates this |
2 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5506 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
2 | 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 |
* |
|
5506 | 21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
2 | 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 |
|
24865
09b1d992ca72
8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents:
5506
diff
changeset
|
46 |
* @since 1.1 |
2 | 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 |
} |