forked from bjmashibing/java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDataInput.html
More file actions
1079 lines (1071 loc) · 43.5 KB
/
Copy pathDataInput.html
File metadata and controls
1079 lines (1071 loc) · 43.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>DataInput (Java SE 12 & JDK 12 )</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="keywords" content="java.io.DataInput interface">
<meta name="keywords" content="readFully()">
<meta name="keywords" content="skipBytes()">
<meta name="keywords" content="readBoolean()">
<meta name="keywords" content="readByte()">
<meta name="keywords" content="readUnsignedByte()">
<meta name="keywords" content="readShort()">
<meta name="keywords" content="readUnsignedShort()">
<meta name="keywords" content="readChar()">
<meta name="keywords" content="readInt()">
<meta name="keywords" content="readLong()">
<meta name="keywords" content="readFloat()">
<meta name="keywords" content="readDouble()">
<meta name="keywords" content="readLine()">
<meta name="keywords" content="readUTF()">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DataInput (Java SE 12 & JDK 12 )";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DataInput.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><div style="margin-top: 14px;"><strong>Java SE 12 & JDK 12</strong> </div></div>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding"> </div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="moduleLabelInType">Module</span> <a href="../../module-summary.html">java.base</a></div>
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">java.io</a></div>
<h2 title="Interface DataInput" class="title">Interface DataInput</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="../../../java.desktop/javax/imageio/stream/ImageInputStream.html" title="interface in javax.imageio.stream">ImageInputStream</a></code>, <code><a href="../../../java.desktop/javax/imageio/stream/ImageOutputStream.html" title="interface in javax.imageio.stream">ImageOutputStream</a></code>, <code><a href="ObjectInput.html" title="interface in java.io">ObjectInput</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="DataInputStream.html" title="class in java.io">DataInputStream</a></code>, <code><a href="../../../java.desktop/javax/imageio/stream/FileCacheImageInputStream.html" title="class in javax.imageio.stream">FileCacheImageInputStream</a></code>, <code><a href="../../../java.desktop/javax/imageio/stream/FileCacheImageOutputStream.html" title="class in javax.imageio.stream">FileCacheImageOutputStream</a></code>, <code><a href="../../../java.desktop/javax/imageio/stream/FileImageInputStream.html" title="class in javax.imageio.stream">FileImageInputStream</a></code>, <code><a href="../../../java.desktop/javax/imageio/stream/FileImageOutputStream.html" title="class in javax.imageio.stream">FileImageOutputStream</a></code>, <code><a href="../../../java.desktop/javax/imageio/stream/ImageInputStreamImpl.html" title="class in javax.imageio.stream">ImageInputStreamImpl</a></code>, <code><a href="../../../java.desktop/javax/imageio/stream/ImageOutputStreamImpl.html" title="class in javax.imageio.stream">ImageOutputStreamImpl</a></code>, <code><a href="../../../java.desktop/javax/imageio/stream/MemoryCacheImageInputStream.html" title="class in javax.imageio.stream">MemoryCacheImageInputStream</a></code>, <code><a href="../../../java.desktop/javax/imageio/stream/MemoryCacheImageOutputStream.html" title="class in javax.imageio.stream">MemoryCacheImageOutputStream</a></code>, <code><a href="ObjectInputStream.html" title="class in java.io">ObjectInputStream</a></code>, <code><a href="RandomAccessFile.html" title="class in java.io">RandomAccessFile</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">DataInput</span></pre>
<div class="block">The <code>DataInput</code> interface provides
for reading bytes from a binary stream and
reconstructing from them data in any of
the Java primitive types. There is also
a
facility for reconstructing a <code>String</code>
from data in
<a href="#modified-utf-8">modified UTF-8</a>
format.
<p>
It is generally true of all the reading
routines in this interface that if end of
file is reached before the desired number
of bytes has been read, an <code>EOFException</code>
(which is a kind of <code>IOException</code>)
is thrown. If any byte cannot be read for
any reason other than end of file, an <code>IOException</code>
other than <code>EOFException</code> is
thrown. In particular, an <code>IOException</code>
may be thrown if the input stream has been
closed.
<h3><a id="modified-utf-8">Modified UTF-8</a></h3>
<p>
Implementations of the DataInput and DataOutput interfaces represent
Unicode strings in a format that is a slight modification of UTF-8.
(For information regarding the standard UTF-8 format, see section
<i>3.9 Unicode Encoding Forms</i> of <i>The Unicode Standard, Version
4.0</i>)
<ul>
<li>Characters in the range <code>'\u0001'</code> to
<code>'\u007F'</code> are represented by a single byte.
<li>The null character <code>'\u0000'</code> and characters
in the range <code>'\u0080'</code> to <code>'\u07FF'</code> are
represented by a pair of bytes.
<li>Characters in the range <code>'\u0800'</code>
to <code>'\uFFFF'</code> are represented by three bytes.
</ul>
<table class="plain" style="margin-left:2em;">
<caption>Encoding of UTF-8 values</caption>
<thead>
<tr>
<th scope="col" rowspan="2">Value</th>
<th scope="col" rowspan="2">Byte</th>
<th scope="col" colspan="8" id="bit_a">Bit Values</th>
</tr>
<tr>
<!-- Value -->
<!-- Byte -->
<th scope="col" style="width:3em"> 7 </th>
<th scope="col" style="width:3em"> 6 </th>
<th scope="col" style="width:3em"> 5 </th>
<th scope="col" style="width:3em"> 4 </th>
<th scope="col" style="width:3em"> 3 </th>
<th scope="col" style="width:3em"> 2 </th>
<th scope="col" style="width:3em"> 1 </th>
<th scope="col" style="width:3em"> 0 </th>
</thead>
<tbody>
<tr>
<th scope="row" style="text-align:left; font-weight:normal">
<code>\u0001</code> to <code>\u007F</code> </th>
<th scope="row" style="font-weight:normal; text-align:center"> 1 </th>
<td style="text-align:center">0
<td colspan="7" style="text-align:right; padding-right:6em">bits 6-0
</tr>
<tr>
<th scope="row" rowspan="2" style="text-align:left; font-weight:normal">
<code>\u0000</code>,<br>
<code>\u0080</code> to <code>\u07FF</code> </th>
<th scope="row" style="font-weight:normal; text-align:center"> 1 </th>
<td style="text-align:center">1
<td style="text-align:center">1
<td style="text-align:center">0
<td colspan="5" style="text-align:right; padding-right:6em">bits 10-6
</tr>
<tr>
<!-- (value) -->
<th scope="row" style="font-weight:normal; text-align:center"> 2 </th>
<td style="text-align:center">1
<td style="text-align:center">0
<td colspan="6" style="text-align:right; padding-right:6em">bits 5-0
</tr>
<tr>
<th scope="row" rowspan="3" style="text-align:left; font-weight:normal">
<code>\u0800</code> to <code>\uFFFF</code> </th>
<th scope="row" style="font-weight:normal; text-align:center"> 1 </th>
<td style="text-align:center">1
<td style="text-align:center">1
<td style="text-align:center">1
<td style="text-align:center">0
<td colspan="4" style="text-align:right; padding-right:6em">bits 15-12
</tr>
<tr>
<!-- (value) -->
<th scope="row" style="font-weight:normal; text-align:center"> 2 </th>
<td style="text-align:center">1
<td style="text-align:center">0
<td colspan="6" style="text-align:right; padding-right:6em">bits 11-6
</tr>
<tr>
<!-- (value) -->
<th scope="row" style="font-weight:normal; text-align:center"> 3 </th>
<td style="text-align:center">1
<td style="text-align:center">0
<td colspan="6" style="text-align:right; padding-right:6em">bits 5-0
</tr>
</tbody>
</table>
<p>
The differences between this format and the
standard UTF-8 format are the following:
<ul>
<li>The null byte <code>'\u0000'</code> is encoded in 2-byte format
rather than 1-byte, so that the encoded strings never have
embedded nulls.
<li>Only the 1-byte, 2-byte, and 3-byte formats are used.
<li><a href="../lang/Character.html#unicode">Supplementary characters</a>
are represented in the form of surrogate pairs.
</ul></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="DataInputStream.html" title="class in java.io"><code>DataInputStream</code></a>,
<a href="DataOutput.html" title="interface in java.io"><code>DataOutput</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readBoolean()">readBoolean</a></span>()</code></th>
<td class="colLast">
<div class="block">Reads one input byte and returns
<code>true</code> if that byte is nonzero,
<code>false</code> if that byte is zero.</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>byte</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readByte()">readByte</a></span>()</code></th>
<td class="colLast">
<div class="block">Reads and returns one input byte.</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>char</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readChar()">readChar</a></span>()</code></th>
<td class="colLast">
<div class="block">Reads two input bytes and returns a <code>char</code> value.</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readDouble()">readDouble</a></span>()</code></th>
<td class="colLast">
<div class="block">Reads eight input bytes and returns
a <code>double</code> value.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code>float</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readFloat()">readFloat</a></span>()</code></th>
<td class="colLast">
<div class="block">Reads four input bytes and returns
a <code>float</code> value.</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readFully(byte%5B%5D)">readFully</a></span>​(byte[] b)</code></th>
<td class="colLast">
<div class="block">Reads some bytes from an input
stream and stores them into the buffer
array <code>b</code>.</div>
</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readFully(byte%5B%5D,int,int)">readFully</a></span>​(byte[] b,
int off,
int len)</code></th>
<td class="colLast">
<div class="block">Reads <code>len</code>
bytes from
an input stream.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readInt()">readInt</a></span>()</code></th>
<td class="colLast">
<div class="block">Reads four input bytes and returns an
<code>int</code> value.</div>
</td>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><code><a href="../lang/String.html" title="class in java.lang">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readLine()">readLine</a></span>()</code></th>
<td class="colLast">
<div class="block">Reads the next line of text from the input stream.</div>
</td>
</tr>
<tr class="rowColor" id="i9">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readLong()">readLong</a></span>()</code></th>
<td class="colLast">
<div class="block">Reads eight input bytes and returns
a <code>long</code> value.</div>
</td>
</tr>
<tr class="altColor" id="i10">
<td class="colFirst"><code>short</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readShort()">readShort</a></span>()</code></th>
<td class="colLast">
<div class="block">Reads two input bytes and returns
a <code>short</code> value.</div>
</td>
</tr>
<tr class="rowColor" id="i11">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readUnsignedByte()">readUnsignedByte</a></span>()</code></th>
<td class="colLast">
<div class="block">Reads one input byte, zero-extends
it to type <code>int</code>, and returns
the result, which is therefore in the range
<code>0</code>
through <code>255</code>.</div>
</td>
</tr>
<tr class="altColor" id="i12">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readUnsignedShort()">readUnsignedShort</a></span>()</code></th>
<td class="colLast">
<div class="block">Reads two input bytes and returns
an <code>int</code> value in the range <code>0</code>
through <code>65535</code>.</div>
</td>
</tr>
<tr class="rowColor" id="i13">
<td class="colFirst"><code><a href="../lang/String.html" title="class in java.lang">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readUTF()">readUTF</a></span>()</code></th>
<td class="colLast">
<div class="block">Reads in a string that has been encoded using a
<a href="#modified-utf-8">modified UTF-8</a>
format.</div>
</td>
</tr>
<tr class="altColor" id="i14">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#skipBytes(int)">skipBytes</a></span>​(int n)</code></th>
<td class="colLast">
<div class="block">Makes an attempt to skip over
<code>n</code> bytes
of data from the input
stream, discarding the skipped bytes.</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="readFully(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readFully</h4>
<pre class="methodSignature">void readFully​(byte[] b)
throws <a href="IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">Reads some bytes from an input
stream and stores them into the buffer
array <code>b</code>. The number of bytes
read is equal
to the length of <code>b</code>.
<p>
This method blocks until one of the
following conditions occurs:
<ul>
<li><code>b.length</code>
bytes of input data are available, in which
case a normal return is made.
<li>End of
file is detected, in which case an <code>EOFException</code>
is thrown.
<li>An I/O error occurs, in
which case an <code>IOException</code> other
than <code>EOFException</code> is thrown.
</ul>
<p>
If <code>b</code> is <code>null</code>,
a <code>NullPointerException</code> is thrown.
If <code>b.length</code> is zero, then
no bytes are read. Otherwise, the first
byte read is stored into element <code>b[0]</code>,
the next one into <code>b[1]</code>, and
so on.
If an exception is thrown from
this method, then it may be that some but
not all bytes of <code>b</code> have been
updated with data from the input stream.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>b</code> - the buffer into which the data is read.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - if <code>b</code> is <code>null</code>.</dd>
<dd><code><a href="EOFException.html" title="class in java.io">EOFException</a></code> - if this stream reaches the end before reading
all the bytes.</dd>
<dd><code><a href="IOException.html" title="class in java.io">IOException</a></code> - if an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a id="readFully(byte[],int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readFully</h4>
<pre class="methodSignature">void readFully​(byte[] b,
int off,
int len)
throws <a href="IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">Reads <code>len</code>
bytes from
an input stream.
<p>
This method
blocks until one of the following conditions
occurs:
<ul>
<li><code>len</code> bytes
of input data are available, in which case
a normal return is made.
<li>End of file
is detected, in which case an <code>EOFException</code>
is thrown.
<li>An I/O error occurs, in
which case an <code>IOException</code> other
than <code>EOFException</code> is thrown.
</ul>
<p>
If <code>b</code> is <code>null</code>,
a <code>NullPointerException</code> is thrown.
If <code>off</code> is negative, or <code>len</code>
is negative, or <code>off+len</code> is
greater than the length of the array <code>b</code>,
then an <code>IndexOutOfBoundsException</code>
is thrown.
If <code>len</code> is zero,
then no bytes are read. Otherwise, the first
byte read is stored into element <code>b[off]</code>,
the next one into <code>b[off+1]</code>,
and so on. The number of bytes read is,
at most, equal to <code>len</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>b</code> - the buffer into which the data is read.</dd>
<dd><code>off</code> - an int specifying the offset in the data array <code>b</code>.</dd>
<dd><code>len</code> - an int specifying the number of bytes to read.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - if <code>b</code> is <code>null</code>.</dd>
<dd><code><a href="../lang/IndexOutOfBoundsException.html" title="class in java.lang">IndexOutOfBoundsException</a></code> - if <code>off</code> is negative,
<code>len</code> is negative, or <code>len</code> is greater than
<code>b.length - off</code>.</dd>
<dd><code><a href="EOFException.html" title="class in java.io">EOFException</a></code> - if this stream reaches the end before reading
all the bytes.</dd>
<dd><code><a href="IOException.html" title="class in java.io">IOException</a></code> - if an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a id="skipBytes(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>skipBytes</h4>
<pre class="methodSignature">int skipBytes​(int n)
throws <a href="IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">Makes an attempt to skip over
<code>n</code> bytes
of data from the input
stream, discarding the skipped bytes. However,
it may skip
over some smaller number of
bytes, possibly zero. This may result from
any of a
number of conditions; reaching
end of file before <code>n</code> bytes
have been skipped is
only one possibility.
This method never throws an <code>EOFException</code>.
The actual
number of bytes skipped is returned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>n</code> - the number of bytes to be skipped.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes actually skipped.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="IOException.html" title="class in java.io">IOException</a></code> - if an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a id="readBoolean()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readBoolean</h4>
<pre class="methodSignature">boolean readBoolean()
throws <a href="IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">Reads one input byte and returns
<code>true</code> if that byte is nonzero,
<code>false</code> if that byte is zero.
This method is suitable for reading
the byte written by the <code>writeBoolean</code>
method of interface <code>DataOutput</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>boolean</code> value read.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="EOFException.html" title="class in java.io">EOFException</a></code> - if this stream reaches the end before reading
all the bytes.</dd>
<dd><code><a href="IOException.html" title="class in java.io">IOException</a></code> - if an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a id="readByte()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readByte</h4>
<pre class="methodSignature">byte readByte()
throws <a href="IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">Reads and returns one input byte.
The byte is treated as a signed value in
the range <code>-128</code> through <code>127</code>,
inclusive.
This method is suitable for
reading the byte written by the <code>writeByte</code>
method of interface <code>DataOutput</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the 8-bit value read.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="EOFException.html" title="class in java.io">EOFException</a></code> - if this stream reaches the end before reading
all the bytes.</dd>
<dd><code><a href="IOException.html" title="class in java.io">IOException</a></code> - if an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a id="readUnsignedByte()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readUnsignedByte</h4>
<pre class="methodSignature">int readUnsignedByte()
throws <a href="IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">Reads one input byte, zero-extends
it to type <code>int</code>, and returns
the result, which is therefore in the range
<code>0</code>
through <code>255</code>.
This method is suitable for reading
the byte written by the <code>writeByte</code>
method of interface <code>DataOutput</code>
if the argument to <code>writeByte</code>
was intended to be a value in the range
<code>0</code> through <code>255</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the unsigned 8-bit value read.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="EOFException.html" title="class in java.io">EOFException</a></code> - if this stream reaches the end before reading
all the bytes.</dd>
<dd><code><a href="IOException.html" title="class in java.io">IOException</a></code> - if an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a id="readShort()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readShort</h4>
<pre class="methodSignature">short readShort()
throws <a href="IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">Reads two input bytes and returns
a <code>short</code> value. Let <code>a</code>
be the first byte read and <code>b</code>
be the second byte. The value
returned
is:
<pre><code>(short)((a << 8) | (b & 0xff))
</code></pre>
This method
is suitable for reading the bytes written
by the <code>writeShort</code> method of
interface <code>DataOutput</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the 16-bit value read.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="EOFException.html" title="class in java.io">EOFException</a></code> - if this stream reaches the end before reading
all the bytes.</dd>
<dd><code><a href="IOException.html" title="class in java.io">IOException</a></code> - if an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a id="readUnsignedShort()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readUnsignedShort</h4>
<pre class="methodSignature">int readUnsignedShort()
throws <a href="IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">Reads two input bytes and returns
an <code>int</code> value in the range <code>0</code>
through <code>65535</code>. Let <code>a</code>
be the first byte read and
<code>b</code>
be the second byte. The value returned is:
<pre><code>(((a & 0xff) << 8) | (b & 0xff))
</code></pre>
This method is suitable for reading the bytes
written by the <code>writeShort</code> method
of interface <code>DataOutput</code> if
the argument to <code>writeShort</code>
was intended to be a value in the range
<code>0</code> through <code>65535</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the unsigned 16-bit value read.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="EOFException.html" title="class in java.io">EOFException</a></code> - if this stream reaches the end before reading
all the bytes.</dd>
<dd><code><a href="IOException.html" title="class in java.io">IOException</a></code> - if an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a id="readChar()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readChar</h4>
<pre class="methodSignature">char readChar()
throws <a href="IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">Reads two input bytes and returns a <code>char</code> value.
Let <code>a</code>
be the first byte read and <code>b</code>
be the second byte. The value
returned is:
<pre><code>(char)((a << 8) | (b & 0xff))
</code></pre>
This method
is suitable for reading bytes written by
the <code>writeChar</code> method of interface
<code>DataOutput</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>char</code> value read.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="EOFException.html" title="class in java.io">EOFException</a></code> - if this stream reaches the end before reading
all the bytes.</dd>
<dd><code><a href="IOException.html" title="class in java.io">IOException</a></code> - if an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a id="readInt()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readInt</h4>
<pre class="methodSignature">int readInt()
throws <a href="IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">Reads four input bytes and returns an
<code>int</code> value. Let <code>a-d</code>
be the first through fourth bytes read. The value returned is:
<pre><code>
(((a & 0xff) << 24) | ((b & 0xff) << 16) |
((c & 0xff) << 8) | (d & 0xff))
</code></pre>
This method is suitable
for reading bytes written by the <code>writeInt</code>
method of interface <code>DataOutput</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>int</code> value read.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="EOFException.html" title="class in java.io">EOFException</a></code> - if this stream reaches the end before reading
all the bytes.</dd>
<dd><code><a href="IOException.html" title="class in java.io">IOException</a></code> - if an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a id="readLong()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readLong</h4>
<pre class="methodSignature">long readLong()
throws <a href="IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">Reads eight input bytes and returns
a <code>long</code> value. Let <code>a-h</code>
be the first through eighth bytes read.
The value returned is:
<pre><code>
(((long)(a & 0xff) << 56) |
((long)(b & 0xff) << 48) |
((long)(c & 0xff) << 40) |
((long)(d & 0xff) << 32) |
((long)(e & 0xff) << 24) |
((long)(f & 0xff) << 16) |
((long)(g & 0xff) << 8) |
((long)(h & 0xff)))
</code></pre>
<p>
This method is suitable
for reading bytes written by the <code>writeLong</code>
method of interface <code>DataOutput</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>long</code> value read.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="EOFException.html" title="class in java.io">EOFException</a></code> - if this stream reaches the end before reading
all the bytes.</dd>
<dd><code><a href="IOException.html" title="class in java.io">IOException</a></code> - if an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a id="readFloat()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readFloat</h4>
<pre class="methodSignature">float readFloat()
throws <a href="IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">Reads four input bytes and returns
a <code>float</code> value. It does this
by first constructing an <code>int</code>
value in exactly the manner
of the <code>readInt</code>
method, then converting this <code>int</code>
value to a <code>float</code> in
exactly the manner of the method <code>Float.intBitsToFloat</code>.
This method is suitable for reading
bytes written by the <code>writeFloat</code>
method of interface <code>DataOutput</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>float</code> value read.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="EOFException.html" title="class in java.io">EOFException</a></code> - if this stream reaches the end before reading
all the bytes.</dd>
<dd><code><a href="IOException.html" title="class in java.io">IOException</a></code> - if an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a id="readDouble()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readDouble</h4>
<pre class="methodSignature">double readDouble()
throws <a href="IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">Reads eight input bytes and returns
a <code>double</code> value. It does this
by first constructing a <code>long</code>
value in exactly the manner
of the <code>readLong</code>
method, then converting this <code>long</code>
value to a <code>double</code> in exactly
the manner of the method <code>Double.longBitsToDouble</code>.
This method is suitable for reading
bytes written by the <code>writeDouble</code>
method of interface <code>DataOutput</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>double</code> value read.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="EOFException.html" title="class in java.io">EOFException</a></code> - if this stream reaches the end before reading
all the bytes.</dd>
<dd><code><a href="IOException.html" title="class in java.io">IOException</a></code> - if an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a id="readLine()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readLine</h4>
<pre class="methodSignature"><a href="../lang/String.html" title="class in java.lang">String</a> readLine()
throws <a href="IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">Reads the next line of text from the input stream.
It reads successive bytes, converting
each byte separately into a character,
until it encounters a line terminator or
end of
file; the characters read are then
returned as a <code>String</code>. Note
that because this
method processes bytes,
it does not support input of the full Unicode
character set.
<p>
If end of file is encountered
before even one byte can be read, then <code>null</code>
is returned. Otherwise, each byte that is
read is converted to type <code>char</code>
by zero-extension. If the character <code>'\n'</code>
is encountered, it is discarded and reading
ceases. If the character <code>'\r'</code>
is encountered, it is discarded and, if
the following byte converts  to the
character <code>'\n'</code>, then that is
discarded also; reading then ceases. If
end of file is encountered before either
of the characters <code>'\n'</code> and
<code>'\r'</code> is encountered, reading
ceases. Once reading has ceased, a <code>String</code>
is returned that contains all the characters
read and not discarded, taken in order.
Note that every character in this string
will have a value less than <code>\u0100</code>,
that is, <code>(char)256</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next line of text from the input stream,
or <code>null</code> if the end of file is
encountered before a byte can be read.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="IOException.html" title="class in java.io">IOException</a></code> - if an I/O error occurs.</dd>
</dl>
</li>
</ul>
<a id="readUTF()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>readUTF</h4>
<pre class="methodSignature"><a href="../lang/String.html" title="class in java.lang">String</a> readUTF()
throws <a href="IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">Reads in a string that has been encoded using a
<a href="#modified-utf-8">modified UTF-8</a>
format.
The general contract of <code>readUTF</code>
is that it reads a representation of a Unicode
character string encoded in modified
UTF-8 format; this string of characters
is then returned as a <code>String</code>.
<p>
First, two bytes are read and used to
construct an unsigned 16-bit integer in
exactly the manner of the <code>readUnsignedShort</code>
method . This integer value is called the
<i>UTF length</i> and specifies the number
of additional bytes to be read. These bytes
are then converted to characters by considering
them in groups. The length of each group
is computed from the value of the first
byte of the group. The byte following a
group, if any, is the first byte of the
next group.
<p>
If the first byte of a group
matches the bit pattern <code>0xxxxxxx</code>
(where <code>x</code> means "may be <code>0</code>
or <code>1</code>"), then the group consists
of just that byte. The byte is zero-extended
to form a character.
<p>
If the first byte
of a group matches the bit pattern <code>110xxxxx</code>,
then the group consists of that byte <code>a</code>
and a second byte <code>b</code>. If there
is no byte <code>b</code> (because byte
<code>a</code> was the last of the bytes
to be read), or if byte <code>b</code> does
not match the bit pattern <code>10xxxxxx</code>,
then a <code>UTFDataFormatException</code>
is thrown. Otherwise, the group is converted
to the character:
<pre><code>(char)(((a & 0x1F) << 6) | (b & 0x3F))
</code></pre>
If the first byte of a group
matches the bit pattern <code>1110xxxx</code>,
then the group consists of that byte <code>a</code>
and two more bytes <code>b</code> and <code>c</code>.
If there is no byte <code>c</code> (because
byte <code>a</code> was one of the last
two of the bytes to be read), or either
byte <code>b</code> or byte <code>c</code>
does not match the bit pattern <code>10xxxxxx</code>,
then a <code>UTFDataFormatException</code>
is thrown. Otherwise, the group is converted
to the character:
<pre><code>
(char)(((a & 0x0F) << 12) | ((b & 0x3F) << 6) | (c & 0x3F))
</code></pre>
If the first byte of a group matches the
pattern <code>1111xxxx</code> or the pattern
<code>10xxxxxx</code>, then a <code>UTFDataFormatException</code>
is thrown.
<p>
If end of file is encountered
at any time during this entire process,
then an <code>EOFException</code> is thrown.
<p>
After every group has been converted to
a character by this process, the characters