author | martin |
Tue, 15 Sep 2015 21:56:04 -0700 | |
changeset 32649 | 2ee9017c7597 |
parent 32033 | bf24e33c7919 |
child 38373 | 21f4f5eee7cc |
permissions | -rw-r--r-- |
2 | 1 |
/* |
14342
8435a30053c1
7197491: update copyright year to match last edit in jdk8 jdk repository
alanb
parents:
11016
diff
changeset
|
2 |
* Copyright (c) 1996, 2011, 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 to character streams. The only methods that a |
|
31 |
* subclass must implement are write(char[], int, int), flush(), and close(). |
|
32 |
* Most subclasses, however, will override some of the methods defined here in |
|
33 |
* order to provide higher efficiency, additional functionality, or both. |
|
34 |
* |
|
35 |
* @see Writer |
|
36 |
* @see BufferedWriter |
|
37 |
* @see CharArrayWriter |
|
38 |
* @see FilterWriter |
|
39 |
* @see OutputStreamWriter |
|
40 |
* @see FileWriter |
|
41 |
* @see PipedWriter |
|
42 |
* @see PrintWriter |
|
43 |
* @see StringWriter |
|
44 |
* @see Reader |
|
45 |
* |
|
46 |
* @author Mark Reinhold |
|
24865
09b1d992ca72
8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents:
14342
diff
changeset
|
47 |
* @since 1.1 |
2 | 48 |
*/ |
49 |
||
50 |
public abstract class Writer implements Appendable, Closeable, Flushable { |
|
51 |
||
52 |
/** |
|
53 |
* Temporary buffer used to hold writes of strings and single characters |
|
54 |
*/ |
|
55 |
private char[] writeBuffer; |
|
56 |
||
57 |
/** |
|
58 |
* Size of writeBuffer, must be >= 1 |
|
59 |
*/ |
|
11016
e2665f4ac6d2
7110111: Minor Java SE javadoc & Constructor clean up
lancea
parents:
5506
diff
changeset
|
60 |
private static final int WRITE_BUFFER_SIZE = 1024; |
2 | 61 |
|
62 |
/** |
|
63 |
* The object used to synchronize operations on this stream. For |
|
64 |
* efficiency, a character-stream object may use an object other than |
|
65 |
* itself to protect critical sections. A subclass should therefore use |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
66 |
* the object in this field rather than {@code this} or a synchronized |
2 | 67 |
* method. |
68 |
*/ |
|
69 |
protected Object lock; |
|
70 |
||
71 |
/** |
|
72 |
* Creates a new character-stream writer whose critical sections will |
|
73 |
* synchronize on the writer itself. |
|
74 |
*/ |
|
75 |
protected Writer() { |
|
76 |
this.lock = this; |
|
77 |
} |
|
78 |
||
79 |
/** |
|
80 |
* Creates a new character-stream writer whose critical sections will |
|
81 |
* synchronize on the given object. |
|
82 |
* |
|
83 |
* @param lock |
|
84 |
* Object to synchronize on |
|
85 |
*/ |
|
86 |
protected Writer(Object lock) { |
|
87 |
if (lock == null) { |
|
88 |
throw new NullPointerException(); |
|
89 |
} |
|
90 |
this.lock = lock; |
|
91 |
} |
|
92 |
||
93 |
/** |
|
94 |
* Writes a single character. The character to be written is contained in |
|
95 |
* the 16 low-order bits of the given integer value; the 16 high-order bits |
|
96 |
* are ignored. |
|
97 |
* |
|
98 |
* <p> Subclasses that intend to support efficient single-character output |
|
99 |
* should override this method. |
|
100 |
* |
|
101 |
* @param c |
|
102 |
* int specifying a character to be written |
|
103 |
* |
|
104 |
* @throws IOException |
|
105 |
* If an I/O error occurs |
|
106 |
*/ |
|
107 |
public void write(int c) throws IOException { |
|
108 |
synchronized (lock) { |
|
109 |
if (writeBuffer == null){ |
|
11016
e2665f4ac6d2
7110111: Minor Java SE javadoc & Constructor clean up
lancea
parents:
5506
diff
changeset
|
110 |
writeBuffer = new char[WRITE_BUFFER_SIZE]; |
2 | 111 |
} |
112 |
writeBuffer[0] = (char) c; |
|
113 |
write(writeBuffer, 0, 1); |
|
114 |
} |
|
115 |
} |
|
116 |
||
117 |
/** |
|
118 |
* Writes an array of characters. |
|
119 |
* |
|
120 |
* @param cbuf |
|
121 |
* Array of characters to be written |
|
122 |
* |
|
123 |
* @throws IOException |
|
124 |
* If an I/O error occurs |
|
125 |
*/ |
|
126 |
public void write(char cbuf[]) throws IOException { |
|
127 |
write(cbuf, 0, cbuf.length); |
|
128 |
} |
|
129 |
||
130 |
/** |
|
131 |
* Writes a portion of an array of characters. |
|
132 |
* |
|
133 |
* @param cbuf |
|
134 |
* Array of characters |
|
135 |
* |
|
136 |
* @param off |
|
137 |
* Offset from which to start writing characters |
|
138 |
* |
|
139 |
* @param len |
|
140 |
* Number of characters to write |
|
141 |
* |
|
142 |
* @throws IOException |
|
143 |
* If an I/O error occurs |
|
144 |
*/ |
|
32649
2ee9017c7597
8136583: Core libraries should use blessed modifier order
martin
parents:
32033
diff
changeset
|
145 |
public abstract void write(char cbuf[], int off, int len) throws IOException; |
2 | 146 |
|
147 |
/** |
|
148 |
* Writes a string. |
|
149 |
* |
|
150 |
* @param str |
|
151 |
* String to be written |
|
152 |
* |
|
153 |
* @throws IOException |
|
154 |
* If an I/O error occurs |
|
155 |
*/ |
|
156 |
public void write(String str) throws IOException { |
|
157 |
write(str, 0, str.length()); |
|
158 |
} |
|
159 |
||
160 |
/** |
|
161 |
* Writes a portion of a string. |
|
162 |
* |
|
163 |
* @param str |
|
164 |
* A String |
|
165 |
* |
|
166 |
* @param off |
|
167 |
* Offset from which to start writing characters |
|
168 |
* |
|
169 |
* @param len |
|
170 |
* Number of characters to write |
|
171 |
* |
|
172 |
* @throws IndexOutOfBoundsException |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
173 |
* If {@code off} is negative, or {@code len} is negative, |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
174 |
* or {@code off+len} is negative or greater than the length |
2 | 175 |
* of the given string |
176 |
* |
|
177 |
* @throws IOException |
|
178 |
* If an I/O error occurs |
|
179 |
*/ |
|
180 |
public void write(String str, int off, int len) throws IOException { |
|
181 |
synchronized (lock) { |
|
182 |
char cbuf[]; |
|
11016
e2665f4ac6d2
7110111: Minor Java SE javadoc & Constructor clean up
lancea
parents:
5506
diff
changeset
|
183 |
if (len <= WRITE_BUFFER_SIZE) { |
2 | 184 |
if (writeBuffer == null) { |
11016
e2665f4ac6d2
7110111: Minor Java SE javadoc & Constructor clean up
lancea
parents:
5506
diff
changeset
|
185 |
writeBuffer = new char[WRITE_BUFFER_SIZE]; |
2 | 186 |
} |
187 |
cbuf = writeBuffer; |
|
188 |
} else { // Don't permanently allocate very large buffers. |
|
189 |
cbuf = new char[len]; |
|
190 |
} |
|
191 |
str.getChars(off, (off + len), cbuf, 0); |
|
192 |
write(cbuf, 0, len); |
|
193 |
} |
|
194 |
} |
|
195 |
||
196 |
/** |
|
197 |
* Appends the specified character sequence to this writer. |
|
198 |
* |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
199 |
* <p> An invocation of this method of the form {@code out.append(csq)} |
2 | 200 |
* behaves in exactly the same way as the invocation |
201 |
* |
|
202 |
* <pre> |
|
203 |
* out.write(csq.toString()) </pre> |
|
204 |
* |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
205 |
* <p> Depending on the specification of {@code toString} for the |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
206 |
* character sequence {@code csq}, the entire sequence may not be |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
207 |
* appended. For instance, invoking the {@code toString} method of a |
2 | 208 |
* character buffer will return a subsequence whose content depends upon |
209 |
* the buffer's position and limit. |
|
210 |
* |
|
211 |
* @param csq |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
212 |
* The character sequence to append. If {@code csq} is |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
213 |
* {@code null}, then the four characters "{@code null}" are |
2 | 214 |
* appended to this writer. |
215 |
* |
|
216 |
* @return This writer |
|
217 |
* |
|
218 |
* @throws IOException |
|
219 |
* If an I/O error occurs |
|
220 |
* |
|
221 |
* @since 1.5 |
|
222 |
*/ |
|
223 |
public Writer append(CharSequence csq) throws IOException { |
|
224 |
if (csq == null) |
|
225 |
write("null"); |
|
226 |
else |
|
227 |
write(csq.toString()); |
|
228 |
return this; |
|
229 |
} |
|
230 |
||
231 |
/** |
|
232 |
* Appends a subsequence of the specified character sequence to this writer. |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
233 |
* {@code Appendable}. |
2 | 234 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
235 |
* <p> An invocation of this method of the form |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
236 |
* {@code out.append(csq, start, end)} when {@code csq} |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
237 |
* is not {@code null} behaves in exactly the |
2 | 238 |
* same way as the invocation |
239 |
* |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
240 |
* <pre>{@code |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
241 |
* out.write(csq.subSequence(start, end).toString()) |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
242 |
* }</pre> |
2 | 243 |
* |
244 |
* @param csq |
|
245 |
* The character sequence from which a subsequence will be |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
246 |
* appended. If {@code csq} is {@code null}, then characters |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
247 |
* will be appended as if {@code csq} contained the four |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
248 |
* characters "{@code null}". |
2 | 249 |
* |
250 |
* @param start |
|
251 |
* The index of the first character in the subsequence |
|
252 |
* |
|
253 |
* @param end |
|
254 |
* The index of the character following the last character in the |
|
255 |
* subsequence |
|
256 |
* |
|
257 |
* @return This writer |
|
258 |
* |
|
259 |
* @throws IndexOutOfBoundsException |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
260 |
* If {@code start} or {@code end} are negative, {@code start} |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
261 |
* is greater than {@code end}, or {@code end} is greater than |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
262 |
* {@code csq.length()} |
2 | 263 |
* |
264 |
* @throws IOException |
|
265 |
* If an I/O error occurs |
|
266 |
* |
|
267 |
* @since 1.5 |
|
268 |
*/ |
|
269 |
public Writer append(CharSequence csq, int start, int end) throws IOException { |
|
270 |
CharSequence cs = (csq == null ? "null" : csq); |
|
271 |
write(cs.subSequence(start, end).toString()); |
|
272 |
return this; |
|
273 |
} |
|
274 |
||
275 |
/** |
|
276 |
* Appends the specified character to this writer. |
|
277 |
* |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
278 |
* <p> An invocation of this method of the form {@code out.append(c)} |
2 | 279 |
* behaves in exactly the same way as the invocation |
280 |
* |
|
281 |
* <pre> |
|
282 |
* out.write(c) </pre> |
|
283 |
* |
|
284 |
* @param c |
|
285 |
* The 16-bit character to append |
|
286 |
* |
|
287 |
* @return This writer |
|
288 |
* |
|
289 |
* @throws IOException |
|
290 |
* If an I/O error occurs |
|
291 |
* |
|
292 |
* @since 1.5 |
|
293 |
*/ |
|
294 |
public Writer append(char c) throws IOException { |
|
295 |
write(c); |
|
296 |
return this; |
|
297 |
} |
|
298 |
||
299 |
/** |
|
300 |
* Flushes the stream. If the stream has saved any characters from the |
|
301 |
* various write() methods in a buffer, write them immediately to their |
|
302 |
* intended destination. Then, if that destination is another character or |
|
303 |
* byte stream, flush it. Thus one flush() invocation will flush all the |
|
304 |
* buffers in a chain of Writers and OutputStreams. |
|
305 |
* |
|
306 |
* <p> If the intended destination of this stream is an abstraction provided |
|
307 |
* by the underlying operating system, for example a file, then flushing the |
|
308 |
* stream guarantees only that bytes previously written to the stream are |
|
309 |
* passed to the operating system for writing; it does not guarantee that |
|
310 |
* they are actually written to a physical device such as a disk drive. |
|
311 |
* |
|
312 |
* @throws IOException |
|
313 |
* If an I/O error occurs |
|
314 |
*/ |
|
32649
2ee9017c7597
8136583: Core libraries should use blessed modifier order
martin
parents:
32033
diff
changeset
|
315 |
public abstract void flush() throws IOException; |
2 | 316 |
|
317 |
/** |
|
318 |
* Closes the stream, flushing it first. Once the stream has been closed, |
|
319 |
* further write() or flush() invocations will cause an IOException to be |
|
320 |
* thrown. Closing a previously closed stream has no effect. |
|
321 |
* |
|
322 |
* @throws IOException |
|
323 |
* If an I/O error occurs |
|
324 |
*/ |
|
32649
2ee9017c7597
8136583: Core libraries should use blessed modifier order
martin
parents:
32033
diff
changeset
|
325 |
public abstract void close() throws IOException; |
2 | 326 |
|
327 |
} |