author | chegar |
Thu, 17 Oct 2019 20:54:25 +0100 | |
branch | datagramsocketimpl-branch |
changeset 58679 | 9c3209ff7550 |
parent 58678 | 9cf78a70fa4f |
parent 58288 | 48e480e56aad |
permissions | -rw-r--r-- |
2 | 1 |
/* |
58242
94bb65cb37d3
8230648: Replace @exception tag with @throws in java.base
jboes
parents:
47216
diff
changeset
|
2 |
* Copyright (c) 1996, 2019, 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 |
||
26 |
package java.io; |
|
27 |
||
28 |
||
29 |
/** |
|
30 |
* Abstract class for reading filtered character streams. |
|
58288
48e480e56aad
8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents:
58242
diff
changeset
|
31 |
* The abstract class {@code FilterReader} itself |
2 | 32 |
* provides default methods that pass all requests to |
58288
48e480e56aad
8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents:
58242
diff
changeset
|
33 |
* the contained stream. Subclasses of {@code FilterReader} |
2 | 34 |
* should override some of these methods and may also provide |
35 |
* additional methods and fields. |
|
36 |
* |
|
37 |
* @author Mark Reinhold |
|
24865
09b1d992ca72
8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents:
5506
diff
changeset
|
38 |
* @since 1.1 |
2 | 39 |
*/ |
40 |
||
41 |
public abstract class FilterReader extends Reader { |
|
42 |
||
43 |
/** |
|
44 |
* The underlying character-input stream. |
|
45 |
*/ |
|
46 |
protected Reader in; |
|
47 |
||
48 |
/** |
|
49 |
* Creates a new filtered reader. |
|
50 |
* |
|
51 |
* @param in a Reader object providing the underlying stream. |
|
58288
48e480e56aad
8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents:
58242
diff
changeset
|
52 |
* @throws NullPointerException if {@code in} is {@code null} |
2 | 53 |
*/ |
54 |
protected FilterReader(Reader in) { |
|
55 |
super(in); |
|
56 |
this.in = in; |
|
57 |
} |
|
58 |
||
59 |
/** |
|
60 |
* Reads a single character. |
|
61 |
* |
|
58242
94bb65cb37d3
8230648: Replace @exception tag with @throws in java.base
jboes
parents:
47216
diff
changeset
|
62 |
* @throws IOException If an I/O error occurs |
2 | 63 |
*/ |
64 |
public int read() throws IOException { |
|
65 |
return in.read(); |
|
66 |
} |
|
67 |
||
68 |
/** |
|
69 |
* Reads characters into a portion of an array. |
|
70 |
* |
|
58242
94bb65cb37d3
8230648: Replace @exception tag with @throws in java.base
jboes
parents:
47216
diff
changeset
|
71 |
* @throws IOException If an I/O error occurs |
94bb65cb37d3
8230648: Replace @exception tag with @throws in java.base
jboes
parents:
47216
diff
changeset
|
72 |
* @throws IndexOutOfBoundsException {@inheritDoc} |
2 | 73 |
*/ |
74 |
public int read(char cbuf[], int off, int len) throws IOException { |
|
75 |
return in.read(cbuf, off, len); |
|
76 |
} |
|
77 |
||
78 |
/** |
|
79 |
* Skips characters. |
|
80 |
* |
|
58242
94bb65cb37d3
8230648: Replace @exception tag with @throws in java.base
jboes
parents:
47216
diff
changeset
|
81 |
* @throws IOException If an I/O error occurs |
2 | 82 |
*/ |
83 |
public long skip(long n) throws IOException { |
|
84 |
return in.skip(n); |
|
85 |
} |
|
86 |
||
87 |
/** |
|
88 |
* Tells whether this stream is ready to be read. |
|
89 |
* |
|
58242
94bb65cb37d3
8230648: Replace @exception tag with @throws in java.base
jboes
parents:
47216
diff
changeset
|
90 |
* @throws IOException If an I/O error occurs |
2 | 91 |
*/ |
92 |
public boolean ready() throws IOException { |
|
93 |
return in.ready(); |
|
94 |
} |
|
95 |
||
96 |
/** |
|
97 |
* Tells whether this stream supports the mark() operation. |
|
98 |
*/ |
|
99 |
public boolean markSupported() { |
|
100 |
return in.markSupported(); |
|
101 |
} |
|
102 |
||
103 |
/** |
|
104 |
* Marks the present position in the stream. |
|
105 |
* |
|
58242
94bb65cb37d3
8230648: Replace @exception tag with @throws in java.base
jboes
parents:
47216
diff
changeset
|
106 |
* @throws IOException If an I/O error occurs |
2 | 107 |
*/ |
108 |
public void mark(int readAheadLimit) throws IOException { |
|
109 |
in.mark(readAheadLimit); |
|
110 |
} |
|
111 |
||
112 |
/** |
|
113 |
* Resets the stream. |
|
114 |
* |
|
58242
94bb65cb37d3
8230648: Replace @exception tag with @throws in java.base
jboes
parents:
47216
diff
changeset
|
115 |
* @throws IOException If an I/O error occurs |
2 | 116 |
*/ |
117 |
public void reset() throws IOException { |
|
118 |
in.reset(); |
|
119 |
} |
|
120 |
||
121 |
public void close() throws IOException { |
|
122 |
in.close(); |
|
123 |
} |
|
124 |
||
125 |
} |