annotate src/goodjava/io/BufferedInputStream.java @ 1593:ea62c2316b2e

docs
author Franklin Schmidt <fschmidt@gmail.com>
date Sat, 20 Mar 2021 22:29:01 -0600
parents 91c167099462
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1478
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
1 /*
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
2 * Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved.
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
3 * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
4 */
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
5
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
6 package goodjava.io;
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
7
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
8 import java.io.InputStream;
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
9 import java.io.IOException;
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
10
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
11 /**
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
12 * A <code>BufferedInputStream</code> adds
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
13 * functionality to another input stream-namely,
1480
1f41e5921090 input buffering
Franklin Schmidt <fschmidt@gmail.com>
parents: 1479
diff changeset
14 * the ability to buffer the input. When the <code>BufferedInputStream</code>
1478
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
15 * is created, an internal buffer array is
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
16 * created. As bytes from the stream are read
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
17 * or skipped, the internal buffer is refilled
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
18 * as necessary from the contained input stream,
1480
1f41e5921090 input buffering
Franklin Schmidt <fschmidt@gmail.com>
parents: 1479
diff changeset
19 * many bytes at a time.
1478
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
20 *
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
21 * @author Arthur van Hoff
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
22 * @since JDK1.0
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
23 */
1494
91c167099462 more io
Franklin Schmidt <fschmidt@gmail.com>
parents: 1489
diff changeset
24 public final class BufferedInputStream extends NoMarkInputStream {
1480
1f41e5921090 input buffering
Franklin Schmidt <fschmidt@gmail.com>
parents: 1479
diff changeset
25 private final byte buf[];
1478
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
26
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
27 /**
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
28 * The index one greater than the index of the last valid byte in
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
29 * the buffer.
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
30 * This value is always
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
31 * in the range <code>0</code> through <code>buf.length</code>;
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
32 * elements <code>buf[0]</code> through <code>buf[count-1]
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
33 * </code>contain buffered input data obtained
1480
1f41e5921090 input buffering
Franklin Schmidt <fschmidt@gmail.com>
parents: 1479
diff changeset
34 * from the underlying input stream.
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
35 */
1480
1f41e5921090 input buffering
Franklin Schmidt <fschmidt@gmail.com>
parents: 1479
diff changeset
36 private int count;
1478
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
37
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
38 /**
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
39 * The current position in the buffer. This is the index of the next
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
40 * character to be read from the <code>buf</code> array.
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
41 * <p>
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
42 * This value is always in the range <code>0</code>
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
43 * through <code>count</code>. If it is less
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
44 * than <code>count</code>, then <code>buf[pos]</code>
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
45 * is the next byte to be supplied as input;
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
46 * if it is equal to <code>count</code>, then
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
47 * the next <code>read</code> or <code>skip</code>
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
48 * operation will require more bytes to be
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
49 * read from the contained input stream.
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
50 *
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
51 * @see java.io.BufferedInputStream#buf
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
52 */
1480
1f41e5921090 input buffering
Franklin Schmidt <fschmidt@gmail.com>
parents: 1479
diff changeset
53 private int pos;
1478
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
54
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
55 /**
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
56 * Creates a <code>BufferedInputStream</code>
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
57 * and saves its argument, the input stream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
58 * <code>in</code>, for later use. An internal
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
59 * buffer array is created and stored in <code>buf</code>.
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
60 *
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
61 * @param in the underlying input stream.
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
62 */
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
63 public BufferedInputStream(InputStream in) {
1483
Franklin Schmidt <fschmidt@gmail.com>
parents: 1480
diff changeset
64 this(in, 8192);
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
65 }
1478
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
66
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
67 /**
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
68 * Creates a <code>BufferedInputStream</code>
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
69 * with the specified buffer size,
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
70 * and saves its argument, the input stream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
71 * <code>in</code>, for later use. An internal
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
72 * buffer array of length <code>size</code>
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
73 * is created and stored in <code>buf</code>.
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
74 *
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
75 * @param in the underlying input stream.
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
76 * @param size the buffer size.
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
77 */
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
78 public BufferedInputStream(InputStream in, int size) {
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
79 super(in);
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
80 buf = new byte[size];
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
81 }
1478
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
82
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
83 /**
1480
1f41e5921090 input buffering
Franklin Schmidt <fschmidt@gmail.com>
parents: 1479
diff changeset
84 * Fills the buffer with more data.
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
85 * This method also assumes that all data has already been read in,
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
86 * hence pos > count.
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
87 */
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
88 private void fill() throws IOException {
1480
1f41e5921090 input buffering
Franklin Schmidt <fschmidt@gmail.com>
parents: 1479
diff changeset
89 pos = 0;
1f41e5921090 input buffering
Franklin Schmidt <fschmidt@gmail.com>
parents: 1479
diff changeset
90 count = 0;
1494
91c167099462 more io
Franklin Schmidt <fschmidt@gmail.com>
parents: 1489
diff changeset
91 int n = in.read(buf, 0, buf.length);
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
92 if (n > 0)
1480
1f41e5921090 input buffering
Franklin Schmidt <fschmidt@gmail.com>
parents: 1479
diff changeset
93 count = n;
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
94 }
1478
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
95
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
96 /**
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
97 * See
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
98 * the general contract of the <code>read</code>
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
99 * method of <code>InputStream</code>.
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
100 *
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
101 * @return the next byte of data, or <code>-1</code> if the end of the
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
102 * stream is reached.
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
103 * @exception IOException if this input stream has been closed by
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
104 * invoking its {@link #close()} method,
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
105 * or an I/O error occurs.
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
106 * @see java.io.FilterInputStream#in
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
107 */
1494
91c167099462 more io
Franklin Schmidt <fschmidt@gmail.com>
parents: 1489
diff changeset
108 public int read() throws IOException {
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
109 if (pos >= count) {
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
110 fill();
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
111 if (pos >= count)
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
112 return -1;
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
113 }
1480
1f41e5921090 input buffering
Franklin Schmidt <fschmidt@gmail.com>
parents: 1479
diff changeset
114 return buf[pos++] & 0xff;
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
115 }
1478
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
116
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
117 /**
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
118 * Read characters into a portion of an array, reading from the underlying
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
119 * stream at most once if necessary.
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
120 */
1489
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
121 private int read1(byte[] b, int off, int len) throws IOException {
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
122 int cnt = 0;
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
123 int avail = count - pos;
1489
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
124 if( avail > 0 ) {
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
125 cnt = (avail < len) ? avail : len;
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
126 System.arraycopy(buf, pos, b, off, cnt);
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
127 pos += cnt;
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
128 len -= cnt;
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
129 if( len == 0 )
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
130 return cnt;
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
131 off += cnt;
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
132 }
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
133 if (len >= buf.length) {
1494
91c167099462 more io
Franklin Schmidt <fschmidt@gmail.com>
parents: 1489
diff changeset
134 return cnt + Math.max( 0, in.read(b, off, len) );
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
135 }
1489
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
136 fill();
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
137 if (count <= 0)
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
138 return cnt;
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
139 System.arraycopy(buf, 0, b, off, len);
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
140 pos += len;
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
141 return cnt + len;
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
142 }
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
143
1494
91c167099462 more io
Franklin Schmidt <fschmidt@gmail.com>
parents: 1489
diff changeset
144 public int read(byte[] b, int off, int len) throws IOException {
1489
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
145 if( len == 0 )
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
146 return 0;
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
147 int n = read1(b,off,len);
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
148 return n==0 ? -1 : n;
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
149 }
1478
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
150
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
151 /**
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
152 * See the general contract of the <code>skip</code>
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
153 * method of <code>InputStream</code>.
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
154 *
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
155 * @exception IOException if the stream does not support seek,
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
156 * or if this input stream has been closed by
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
157 * invoking its {@link #close()} method, or an
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
158 * I/O error occurs.
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
159 */
1494
91c167099462 more io
Franklin Schmidt <fschmidt@gmail.com>
parents: 1489
diff changeset
160 public long skip(long n) throws IOException {
1489
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
161 if( n <= 0 )
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
162 return 0;
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
163 long skipped = 0;
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
164 long avail = count - pos;
1489
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
165 if( avail > 0 ) {
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
166 skipped = (avail < n) ? avail : n;
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
167 pos += skipped;
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
168 n -= skipped;
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
169 if( n == 0 )
fe237d72b234 improve BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents: 1483
diff changeset
170 return skipped;
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
171 }
1494
91c167099462 more io
Franklin Schmidt <fschmidt@gmail.com>
parents: 1489
diff changeset
172 return skipped + in.skip(n);
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
173 }
1478
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
174
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
175 /**
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
176 * Returns an estimate of the number of bytes that can be read (or
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
177 * skipped over) from this input stream without blocking by the next
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
178 * invocation of a method for this input stream. The next invocation might be
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
179 * the same thread or another thread. A single read or skip of this
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
180 * many bytes will not block, but may read or skip fewer bytes.
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
181 * <p>
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
182 * This method returns the sum of the number of bytes remaining to be read in
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
183 * the buffer (<code>count&nbsp;- pos</code>) and the result of calling the
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
184 * {@link java.io.FilterInputStream#in in}.available().
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
185 *
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
186 * @return an estimate of the number of bytes that can be read (or skipped
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
187 * over) from this input stream without blocking.
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
188 * @exception IOException if this input stream has been closed by
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
189 * invoking its {@link #close()} method,
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
190 * or an I/O error occurs.
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
191 */
1494
91c167099462 more io
Franklin Schmidt <fschmidt@gmail.com>
parents: 1489
diff changeset
192 public int available() throws IOException {
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
193 int n = count - pos;
1494
91c167099462 more io
Franklin Schmidt <fschmidt@gmail.com>
parents: 1489
diff changeset
194 int avail = in.available();
1479
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
195 return n > (Integer.MAX_VALUE - avail)
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
196 ? Integer.MAX_VALUE
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
197 : n + avail;
Franklin Schmidt <fschmidt@gmail.com>
parents: 1478
diff changeset
198 }
1478
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
199
37e582f2e266 clone BufferedInputStream
Franklin Schmidt <fschmidt@gmail.com>
parents:
diff changeset
200 }