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 writing 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 FilterWriter} itself |
2 | 32 |
* provides default methods that pass all requests to the |
58288
48e480e56aad
8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents:
58242
diff
changeset
|
33 |
* contained stream. Subclasses of {@code FilterWriter} |
2 | 34 |
* should override some of these methods and may also |
35 |
* provide 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 FilterWriter extends Writer { |
|
42 |
||
43 |
/** |
|
44 |
* The underlying character-output stream. |
|
45 |
*/ |
|
46 |
protected Writer out; |
|
47 |
||
48 |
/** |
|
49 |
* Create a new filtered writer. |
|
50 |
* |
|
51 |
* @param out a Writer object to provide 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 out} is {@code null} |
2 | 53 |
*/ |
54 |
protected FilterWriter(Writer out) { |
|
55 |
super(out); |
|
56 |
this.out = out; |
|
57 |
} |
|
58 |
||
59 |
/** |
|
60 |
* Writes 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 void write(int c) throws IOException { |
|
65 |
out.write(c); |
|
66 |
} |
|
67 |
||
68 |
/** |
|
69 |
* Writes a portion of an array of characters. |
|
70 |
* |
|
71 |
* @param cbuf Buffer of characters to be written |
|
72 |
* @param off Offset from which to start reading characters |
|
73 |
* @param len Number of characters to be written |
|
74 |
* |
|
38373
21f4f5eee7cc
8130679: Writer/StringWriter.write methods do not specify index out bounds
bpb
parents:
25859
diff
changeset
|
75 |
* @throws IndexOutOfBoundsException |
21f4f5eee7cc
8130679: Writer/StringWriter.write methods do not specify index out bounds
bpb
parents:
25859
diff
changeset
|
76 |
* If the values of the {@code off} and {@code len} parameters |
21f4f5eee7cc
8130679: Writer/StringWriter.write methods do not specify index out bounds
bpb
parents:
25859
diff
changeset
|
77 |
* cause the corresponding method of the underlying {@code Writer} |
21f4f5eee7cc
8130679: Writer/StringWriter.write methods do not specify index out bounds
bpb
parents:
25859
diff
changeset
|
78 |
* to throw an {@code IndexOutOfBoundsException} |
21f4f5eee7cc
8130679: Writer/StringWriter.write methods do not specify index out bounds
bpb
parents:
25859
diff
changeset
|
79 |
* |
21f4f5eee7cc
8130679: Writer/StringWriter.write methods do not specify index out bounds
bpb
parents:
25859
diff
changeset
|
80 |
* @throws IOException If an I/O error occurs |
2 | 81 |
*/ |
82 |
public void write(char cbuf[], int off, int len) throws IOException { |
|
83 |
out.write(cbuf, off, len); |
|
84 |
} |
|
85 |
||
86 |
/** |
|
87 |
* Writes a portion of a string. |
|
88 |
* |
|
89 |
* @param str String to be written |
|
90 |
* @param off Offset from which to start reading characters |
|
91 |
* @param len Number of characters to be written |
|
92 |
* |
|
38373
21f4f5eee7cc
8130679: Writer/StringWriter.write methods do not specify index out bounds
bpb
parents:
25859
diff
changeset
|
93 |
* @throws IndexOutOfBoundsException |
21f4f5eee7cc
8130679: Writer/StringWriter.write methods do not specify index out bounds
bpb
parents:
25859
diff
changeset
|
94 |
* If the values of the {@code off} and {@code len} parameters |
21f4f5eee7cc
8130679: Writer/StringWriter.write methods do not specify index out bounds
bpb
parents:
25859
diff
changeset
|
95 |
* cause the corresponding method of the underlying {@code Writer} |
21f4f5eee7cc
8130679: Writer/StringWriter.write methods do not specify index out bounds
bpb
parents:
25859
diff
changeset
|
96 |
* to throw an {@code IndexOutOfBoundsException} |
21f4f5eee7cc
8130679: Writer/StringWriter.write methods do not specify index out bounds
bpb
parents:
25859
diff
changeset
|
97 |
* |
21f4f5eee7cc
8130679: Writer/StringWriter.write methods do not specify index out bounds
bpb
parents:
25859
diff
changeset
|
98 |
* @throws IOException If an I/O error occurs |
2 | 99 |
*/ |
100 |
public void write(String str, int off, int len) throws IOException { |
|
101 |
out.write(str, off, len); |
|
102 |
} |
|
103 |
||
104 |
/** |
|
105 |
* Flushes the stream. |
|
106 |
* |
|
58242
94bb65cb37d3
8230648: Replace @exception tag with @throws in java.base
jboes
parents:
47216
diff
changeset
|
107 |
* @throws IOException If an I/O error occurs |
2 | 108 |
*/ |
109 |
public void flush() throws IOException { |
|
110 |
out.flush(); |
|
111 |
} |
|
112 |
||
113 |
public void close() throws IOException { |
|
114 |
out.close(); |
|
115 |
} |
|
116 |
||
117 |
} |