author | chegar |
Thu, 17 Oct 2019 20:54:25 +0100 | |
branch | datagramsocketimpl-branch |
changeset 58679 | 9c3209ff7550 |
parent 58678 | 9cf78a70fa4f |
parent 58027 | 930551e8ac62 |
permissions | -rw-r--r-- |
2 | 1 |
/* |
55727 | 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 |
import java.util.Formatter; |
|
29 |
import java.util.Locale; |
|
7966
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
30 |
import java.nio.charset.Charset; |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
31 |
import java.nio.charset.IllegalCharsetNameException; |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
32 |
import java.nio.charset.UnsupportedCharsetException; |
2 | 33 |
|
34 |
/** |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
35 |
* A {@code PrintStream} adds functionality to another output stream, |
2 | 36 |
* namely the ability to print representations of various data values |
37 |
* conveniently. Two other features are provided as well. Unlike other output |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
38 |
* streams, a {@code PrintStream} never throws an |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
39 |
* {@code IOException}; instead, exceptional situations merely set an |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
40 |
* internal flag that can be tested via the {@code checkError} method. |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
41 |
* Optionally, a {@code PrintStream} can be created so as to flush |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
42 |
* automatically; this means that the {@code flush} method is |
2 | 43 |
* automatically invoked after a byte array is written, one of the |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
44 |
* {@code println} methods is invoked, or a newline character or byte |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
45 |
* ({@code '\n'}) is written. |
2 | 46 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
47 |
* <p> All characters printed by a {@code PrintStream} are converted into |
55727 | 48 |
* bytes using the given encoding or charset, or the platform's default |
49 |
* character encoding if not specified. |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
50 |
* The {@link PrintWriter} class should be used in situations that require |
55727 | 51 |
* writing characters rather than bytes. |
2 | 52 |
* |
48252
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
53 |
* <p> This class always replaces malformed and unmappable character sequences with |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
54 |
* the charset's default replacement string. |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
55 |
* The {@linkplain java.nio.charset.CharsetEncoder} class should be used when more |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
56 |
* control over the encoding process is required. |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
57 |
* |
2 | 58 |
* @author Frank Yellin |
59 |
* @author Mark Reinhold |
|
24865
09b1d992ca72
8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents:
23010
diff
changeset
|
60 |
* @since 1.0 |
2 | 61 |
*/ |
62 |
||
63 |
public class PrintStream extends FilterOutputStream |
|
64 |
implements Appendable, Closeable |
|
65 |
{ |
|
66 |
||
7966
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
67 |
private final boolean autoFlush; |
2 | 68 |
private boolean trouble = false; |
69 |
private Formatter formatter; |
|
70 |
||
71 |
/** |
|
72 |
* Track both the text- and character-output streams, so that their buffers |
|
73 |
* can be flushed without flushing the entire stream. |
|
74 |
*/ |
|
75 |
private BufferedWriter textOut; |
|
76 |
private OutputStreamWriter charOut; |
|
77 |
||
78 |
/** |
|
8166
13423c0952ad
7012540: java.util.Objects.nonNull() incorrectly named
briangoetz
parents:
7982
diff
changeset
|
79 |
* requireNonNull is explicitly declared here so as not to create an extra |
13423c0952ad
7012540: java.util.Objects.nonNull() incorrectly named
briangoetz
parents:
7982
diff
changeset
|
80 |
* dependency on java.util.Objects.requireNonNull. PrintStream is loaded |
7966
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
81 |
* early during system initialization. |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
82 |
*/ |
8166
13423c0952ad
7012540: java.util.Objects.nonNull() incorrectly named
briangoetz
parents:
7982
diff
changeset
|
83 |
private static <T> T requireNonNull(T obj, String message) { |
7966
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
84 |
if (obj == null) |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
85 |
throw new NullPointerException(message); |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
86 |
return obj; |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
87 |
} |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
88 |
|
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
89 |
/** |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
90 |
* Returns a charset object for the given charset name. |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
91 |
* @throws NullPointerException is csn is null |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
92 |
* @throws UnsupportedEncodingException if the charset is not supported |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
93 |
*/ |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
94 |
private static Charset toCharset(String csn) |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
95 |
throws UnsupportedEncodingException |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
96 |
{ |
8166
13423c0952ad
7012540: java.util.Objects.nonNull() incorrectly named
briangoetz
parents:
7982
diff
changeset
|
97 |
requireNonNull(csn, "charsetName"); |
7966
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
98 |
try { |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
99 |
return Charset.forName(csn); |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
100 |
} catch (IllegalCharsetNameException|UnsupportedCharsetException unused) { |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
101 |
// UnsupportedEncodingException should be thrown |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
102 |
throw new UnsupportedEncodingException(csn); |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
103 |
} |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
104 |
} |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
105 |
|
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
106 |
/* Private constructors */ |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
107 |
private PrintStream(boolean autoFlush, OutputStream out) { |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
108 |
super(out); |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
109 |
this.autoFlush = autoFlush; |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
110 |
this.charOut = new OutputStreamWriter(this); |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
111 |
this.textOut = new BufferedWriter(charOut); |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
112 |
} |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
113 |
|
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
114 |
/* Variant of the private constructor so that the given charset name |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
115 |
* can be verified before evaluating the OutputStream argument. Used |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
116 |
* by constructors creating a FileOutputStream that also take a |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
117 |
* charset name. |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
118 |
*/ |
48252
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
119 |
private PrintStream(boolean autoFlush, Charset charset, OutputStream out) { |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
120 |
this(out, autoFlush, charset); |
7966
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
121 |
} |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
122 |
|
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
123 |
/** |
55727 | 124 |
* Creates a new print stream, without automatic line flushing, with the |
125 |
* specified OutputStream. Characters written to the stream are converted |
|
126 |
* to bytes using the platform's default character encoding. |
|
2 | 127 |
* |
128 |
* @param out The output stream to which values and objects will be |
|
129 |
* printed |
|
130 |
* |
|
131 |
* @see java.io.PrintWriter#PrintWriter(java.io.OutputStream) |
|
132 |
*/ |
|
133 |
public PrintStream(OutputStream out) { |
|
134 |
this(out, false); |
|
135 |
} |
|
136 |
||
137 |
/** |
|
55727 | 138 |
* Creates a new print stream, with the specified OutputStream and line |
139 |
* flushing. Characters written to the stream are converted to bytes using |
|
140 |
* the platform's default character encoding. |
|
2 | 141 |
* |
142 |
* @param out The output stream to which values and objects will be |
|
143 |
* printed |
|
55727 | 144 |
* @param autoFlush Whether the output buffer will be flushed |
2 | 145 |
* whenever a byte array is written, one of the |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
146 |
* {@code println} methods is invoked, or a newline |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
147 |
* character or byte ({@code '\n'}) is written |
2 | 148 |
* |
149 |
* @see java.io.PrintWriter#PrintWriter(java.io.OutputStream, boolean) |
|
150 |
*/ |
|
151 |
public PrintStream(OutputStream out, boolean autoFlush) { |
|
8166
13423c0952ad
7012540: java.util.Objects.nonNull() incorrectly named
briangoetz
parents:
7982
diff
changeset
|
152 |
this(autoFlush, requireNonNull(out, "Null output stream")); |
2 | 153 |
} |
154 |
||
155 |
/** |
|
55727 | 156 |
* Creates a new print stream, with the specified OutputStream, line |
157 |
* flushing, and character encoding. |
|
2 | 158 |
* |
159 |
* @param out The output stream to which values and objects will be |
|
160 |
* printed |
|
55727 | 161 |
* @param autoFlush Whether the output buffer will be flushed |
2 | 162 |
* whenever a byte array is written, one of the |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
163 |
* {@code println} methods is invoked, or a newline |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
164 |
* character or byte ({@code '\n'}) is written |
2 | 165 |
* @param encoding The name of a supported |
166 |
* <a href="../lang/package-summary.html#charenc"> |
|
167 |
* character encoding</a> |
|
168 |
* |
|
169 |
* @throws UnsupportedEncodingException |
|
170 |
* If the named encoding is not supported |
|
171 |
* |
|
172 |
* @since 1.4 |
|
173 |
*/ |
|
174 |
public PrintStream(OutputStream out, boolean autoFlush, String encoding) |
|
175 |
throws UnsupportedEncodingException |
|
176 |
{ |
|
48252
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
177 |
this(requireNonNull(out, "Null output stream"), autoFlush, toCharset(encoding)); |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
178 |
} |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
179 |
|
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
180 |
/** |
55727 | 181 |
* Creates a new print stream, with the specified OutputStream, line |
48252
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
182 |
* flushing and charset. This convenience constructor creates the necessary |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
183 |
* intermediate {@link java.io.OutputStreamWriter OutputStreamWriter}, |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
184 |
* which will encode characters using the provided charset. |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
185 |
* |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
186 |
* @param out The output stream to which values and objects will be |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
187 |
* printed |
55727 | 188 |
* @param autoFlush Whether the output buffer will be flushed |
48252
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
189 |
* whenever a byte array is written, one of the |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
190 |
* {@code println} methods is invoked, or a newline |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
191 |
* character or byte ({@code '\n'}) is written |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
192 |
* @param charset A {@linkplain java.nio.charset.Charset charset} |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
193 |
* |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
194 |
* @since 10 |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
195 |
*/ |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
196 |
public PrintStream(OutputStream out, boolean autoFlush, Charset charset) { |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
197 |
super(out); |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
198 |
this.autoFlush = autoFlush; |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
199 |
this.charOut = new OutputStreamWriter(this, charset); |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
200 |
this.textOut = new BufferedWriter(charOut); |
2 | 201 |
} |
202 |
||
203 |
/** |
|
204 |
* Creates a new print stream, without automatic line flushing, with the |
|
205 |
* specified file name. This convenience constructor creates |
|
206 |
* the necessary intermediate {@link java.io.OutputStreamWriter |
|
207 |
* OutputStreamWriter}, which will encode characters using the |
|
208 |
* {@linkplain java.nio.charset.Charset#defaultCharset() default charset} |
|
209 |
* for this instance of the Java virtual machine. |
|
210 |
* |
|
211 |
* @param fileName |
|
212 |
* The name of the file to use as the destination of this print |
|
213 |
* stream. If the file exists, then it will be truncated to |
|
214 |
* zero size; otherwise, a new file will be created. The output |
|
215 |
* will be written to the file and is buffered. |
|
216 |
* |
|
217 |
* @throws FileNotFoundException |
|
218 |
* If the given file object does not denote an existing, writable |
|
219 |
* regular file and a new regular file of that name cannot be |
|
220 |
* created, or if some other error occurs while opening or |
|
221 |
* creating the file |
|
222 |
* |
|
223 |
* @throws SecurityException |
|
224 |
* If a security manager is present and {@link |
|
225 |
* SecurityManager#checkWrite checkWrite(fileName)} denies write |
|
226 |
* access to the file |
|
227 |
* |
|
228 |
* @since 1.5 |
|
229 |
*/ |
|
230 |
public PrintStream(String fileName) throws FileNotFoundException { |
|
231 |
this(false, new FileOutputStream(fileName)); |
|
232 |
} |
|
233 |
||
234 |
/** |
|
235 |
* Creates a new print stream, without automatic line flushing, with the |
|
236 |
* specified file name and charset. This convenience constructor creates |
|
237 |
* the necessary intermediate {@link java.io.OutputStreamWriter |
|
238 |
* OutputStreamWriter}, which will encode characters using the provided |
|
239 |
* charset. |
|
240 |
* |
|
241 |
* @param fileName |
|
242 |
* The name of the file to use as the destination of this print |
|
243 |
* stream. If the file exists, then it will be truncated to |
|
244 |
* zero size; otherwise, a new file will be created. The output |
|
245 |
* will be written to the file and is buffered. |
|
246 |
* |
|
247 |
* @param csn |
|
248 |
* The name of a supported {@linkplain java.nio.charset.Charset |
|
249 |
* charset} |
|
250 |
* |
|
251 |
* @throws FileNotFoundException |
|
252 |
* If the given file object does not denote an existing, writable |
|
253 |
* regular file and a new regular file of that name cannot be |
|
254 |
* created, or if some other error occurs while opening or |
|
255 |
* creating the file |
|
256 |
* |
|
257 |
* @throws SecurityException |
|
258 |
* If a security manager is present and {@link |
|
259 |
* SecurityManager#checkWrite checkWrite(fileName)} denies write |
|
260 |
* access to the file |
|
261 |
* |
|
262 |
* @throws UnsupportedEncodingException |
|
263 |
* If the named charset is not supported |
|
264 |
* |
|
265 |
* @since 1.5 |
|
266 |
*/ |
|
267 |
public PrintStream(String fileName, String csn) |
|
268 |
throws FileNotFoundException, UnsupportedEncodingException |
|
269 |
{ |
|
7966
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
270 |
// ensure charset is checked before the file is opened |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
271 |
this(false, toCharset(csn), new FileOutputStream(fileName)); |
2 | 272 |
} |
273 |
||
274 |
/** |
|
275 |
* Creates a new print stream, without automatic line flushing, with the |
|
48252
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
276 |
* specified file name and charset. This convenience constructor creates |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
277 |
* the necessary intermediate {@link java.io.OutputStreamWriter |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
278 |
* OutputStreamWriter}, which will encode characters using the provided |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
279 |
* charset. |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
280 |
* |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
281 |
* @param fileName |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
282 |
* The name of the file to use as the destination of this print |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
283 |
* stream. If the file exists, then it will be truncated to |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
284 |
* zero size; otherwise, a new file will be created. The output |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
285 |
* will be written to the file and is buffered. |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
286 |
* |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
287 |
* @param charset |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
288 |
* A {@linkplain java.nio.charset.Charset charset} |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
289 |
* |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
290 |
* @throws IOException |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
291 |
* if an I/O error occurs while opening or creating the file |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
292 |
* |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
293 |
* @throws SecurityException |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
294 |
* If a security manager is present and {@link |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
295 |
* SecurityManager#checkWrite checkWrite(fileName)} denies write |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
296 |
* access to the file |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
297 |
* |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
298 |
* @since 10 |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
299 |
*/ |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
300 |
public PrintStream(String fileName, Charset charset) throws IOException { |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
301 |
this(false, requireNonNull(charset, "charset"), new FileOutputStream(fileName)); |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
302 |
} |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
303 |
|
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
304 |
/** |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
305 |
* Creates a new print stream, without automatic line flushing, with the |
2 | 306 |
* specified file. This convenience constructor creates the necessary |
307 |
* intermediate {@link java.io.OutputStreamWriter OutputStreamWriter}, |
|
308 |
* which will encode characters using the {@linkplain |
|
309 |
* java.nio.charset.Charset#defaultCharset() default charset} for this |
|
310 |
* instance of the Java virtual machine. |
|
311 |
* |
|
312 |
* @param file |
|
313 |
* The file to use as the destination of this print stream. If the |
|
314 |
* file exists, then it will be truncated to zero size; otherwise, |
|
315 |
* a new file will be created. The output will be written to the |
|
316 |
* file and is buffered. |
|
317 |
* |
|
318 |
* @throws FileNotFoundException |
|
319 |
* If the given file object does not denote an existing, writable |
|
320 |
* regular file and a new regular file of that name cannot be |
|
321 |
* created, or if some other error occurs while opening or |
|
322 |
* creating the file |
|
323 |
* |
|
324 |
* @throws SecurityException |
|
325 |
* If a security manager is present and {@link |
|
326 |
* SecurityManager#checkWrite checkWrite(file.getPath())} |
|
327 |
* denies write access to the file |
|
328 |
* |
|
329 |
* @since 1.5 |
|
330 |
*/ |
|
331 |
public PrintStream(File file) throws FileNotFoundException { |
|
332 |
this(false, new FileOutputStream(file)); |
|
333 |
} |
|
334 |
||
335 |
/** |
|
336 |
* Creates a new print stream, without automatic line flushing, with the |
|
337 |
* specified file and charset. This convenience constructor creates |
|
338 |
* the necessary intermediate {@link java.io.OutputStreamWriter |
|
339 |
* OutputStreamWriter}, which will encode characters using the provided |
|
340 |
* charset. |
|
341 |
* |
|
342 |
* @param file |
|
343 |
* The file to use as the destination of this print stream. If the |
|
344 |
* file exists, then it will be truncated to zero size; otherwise, |
|
345 |
* a new file will be created. The output will be written to the |
|
346 |
* file and is buffered. |
|
347 |
* |
|
348 |
* @param csn |
|
349 |
* The name of a supported {@linkplain java.nio.charset.Charset |
|
350 |
* charset} |
|
351 |
* |
|
352 |
* @throws FileNotFoundException |
|
353 |
* If the given file object does not denote an existing, writable |
|
354 |
* regular file and a new regular file of that name cannot be |
|
355 |
* created, or if some other error occurs while opening or |
|
356 |
* creating the file |
|
357 |
* |
|
358 |
* @throws SecurityException |
|
21278 | 359 |
* If a security manager is present and {@link |
2 | 360 |
* SecurityManager#checkWrite checkWrite(file.getPath())} |
361 |
* denies write access to the file |
|
362 |
* |
|
363 |
* @throws UnsupportedEncodingException |
|
364 |
* If the named charset is not supported |
|
365 |
* |
|
366 |
* @since 1.5 |
|
367 |
*/ |
|
368 |
public PrintStream(File file, String csn) |
|
369 |
throws FileNotFoundException, UnsupportedEncodingException |
|
370 |
{ |
|
7966
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
371 |
// ensure charset is checked before the file is opened |
a23e3f47c5a8
7000511: PrintStream, PrintWriter, Formatter, Scanner leave files open when exception thrown
chegar
parents:
5506
diff
changeset
|
372 |
this(false, toCharset(csn), new FileOutputStream(file)); |
2 | 373 |
} |
374 |
||
48252
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
375 |
|
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
376 |
/** |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
377 |
* Creates a new print stream, without automatic line flushing, with the |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
378 |
* specified file and charset. This convenience constructor creates |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
379 |
* the necessary intermediate {@link java.io.OutputStreamWriter |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
380 |
* OutputStreamWriter}, which will encode characters using the provided |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
381 |
* charset. |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
382 |
* |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
383 |
* @param file |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
384 |
* The file to use as the destination of this print stream. If the |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
385 |
* file exists, then it will be truncated to zero size; otherwise, |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
386 |
* a new file will be created. The output will be written to the |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
387 |
* file and is buffered. |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
388 |
* |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
389 |
* @param charset |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
390 |
* A {@linkplain java.nio.charset.Charset charset} |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
391 |
* |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
392 |
* @throws IOException |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
393 |
* if an I/O error occurs while opening or creating the file |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
394 |
* |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
395 |
* @throws SecurityException |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
396 |
* If a security manager is present and {@link |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
397 |
* SecurityManager#checkWrite checkWrite(file.getPath())} |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
398 |
* denies write access to the file |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
399 |
* |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
400 |
* @since 10 |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
401 |
*/ |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
402 |
public PrintStream(File file, Charset charset) throws IOException { |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
403 |
this(false, requireNonNull(charset, "charset"), new FileOutputStream(file)); |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
404 |
} |
77b88d8f8380
8183743: Umbrella: add overloads that take a Charset parameter
joehw
parents:
47216
diff
changeset
|
405 |
|
2 | 406 |
/** Check to make sure that the stream has not been closed */ |
407 |
private void ensureOpen() throws IOException { |
|
408 |
if (out == null) |
|
409 |
throw new IOException("Stream closed"); |
|
410 |
} |
|
411 |
||
412 |
/** |
|
413 |
* Flushes the stream. This is done by writing any buffered output bytes to |
|
414 |
* the underlying output stream and then flushing that stream. |
|
415 |
* |
|
416 |
* @see java.io.OutputStream#flush() |
|
417 |
*/ |
|
58027
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
418 |
@Override |
2 | 419 |
public void flush() { |
420 |
synchronized (this) { |
|
421 |
try { |
|
422 |
ensureOpen(); |
|
423 |
out.flush(); |
|
424 |
} |
|
425 |
catch (IOException x) { |
|
426 |
trouble = true; |
|
427 |
} |
|
428 |
} |
|
429 |
} |
|
430 |
||
431 |
private boolean closing = false; /* To avoid recursive closing */ |
|
432 |
||
433 |
/** |
|
434 |
* Closes the stream. This is done by flushing the stream and then closing |
|
435 |
* the underlying output stream. |
|
436 |
* |
|
437 |
* @see java.io.OutputStream#close() |
|
438 |
*/ |
|
58027
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
439 |
@Override |
2 | 440 |
public void close() { |
441 |
synchronized (this) { |
|
442 |
if (! closing) { |
|
443 |
closing = true; |
|
444 |
try { |
|
445 |
textOut.close(); |
|
446 |
out.close(); |
|
447 |
} |
|
448 |
catch (IOException x) { |
|
449 |
trouble = true; |
|
450 |
} |
|
451 |
textOut = null; |
|
452 |
charOut = null; |
|
453 |
out = null; |
|
454 |
} |
|
455 |
} |
|
456 |
} |
|
457 |
||
458 |
/** |
|
459 |
* Flushes the stream and checks its error state. The internal error state |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
460 |
* is set to {@code true} when the underlying output stream throws an |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
461 |
* {@code IOException} other than {@code InterruptedIOException}, |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
462 |
* and when the {@code setError} method is invoked. If an operation |
2 | 463 |
* on the underlying output stream throws an |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
464 |
* {@code InterruptedIOException}, then the {@code PrintStream} |
2 | 465 |
* converts the exception back into an interrupt by doing: |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
466 |
* <pre>{@code |
2 | 467 |
* Thread.currentThread().interrupt(); |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
468 |
* }</pre> |
2 | 469 |
* or the equivalent. |
470 |
* |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
471 |
* @return {@code true} if and only if this stream has encountered an |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
472 |
* {@code IOException} other than |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
473 |
* {@code InterruptedIOException}, or the |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
474 |
* {@code setError} method has been invoked |
2 | 475 |
*/ |
476 |
public boolean checkError() { |
|
477 |
if (out != null) |
|
478 |
flush(); |
|
479 |
if (out instanceof java.io.PrintStream) { |
|
480 |
PrintStream ps = (PrintStream) out; |
|
481 |
return ps.checkError(); |
|
482 |
} |
|
483 |
return trouble; |
|
484 |
} |
|
485 |
||
486 |
/** |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
487 |
* Sets the error state of the stream to {@code true}. |
2 | 488 |
* |
489 |
* <p> This method will cause subsequent invocations of {@link |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
490 |
* #checkError()} to return {@code true} until |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
491 |
* {@link #clearError()} is invoked. |
2 | 492 |
* |
24865
09b1d992ca72
8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents:
23010
diff
changeset
|
493 |
* @since 1.1 |
2 | 494 |
*/ |
495 |
protected void setError() { |
|
496 |
trouble = true; |
|
497 |
} |
|
498 |
||
499 |
/** |
|
500 |
* Clears the internal error state of this stream. |
|
501 |
* |
|
502 |
* <p> This method will cause subsequent invocations of {@link |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
503 |
* #checkError()} to return {@code false} until another write |
2 | 504 |
* operation fails and invokes {@link #setError()}. |
505 |
* |
|
506 |
* @since 1.6 |
|
507 |
*/ |
|
508 |
protected void clearError() { |
|
509 |
trouble = false; |
|
510 |
} |
|
511 |
||
512 |
/* |
|
513 |
* Exception-catching, synchronized output operations, |
|
514 |
* which also implement the write() methods of OutputStream |
|
515 |
*/ |
|
516 |
||
517 |
/** |
|
518 |
* Writes the specified byte to this stream. If the byte is a newline and |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
519 |
* automatic flushing is enabled then the {@code flush} method will be |
2 | 520 |
* invoked. |
521 |
* |
|
522 |
* <p> Note that the byte is written as given; to write a character that |
|
523 |
* will be translated according to the platform's default character |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
524 |
* encoding, use the {@code print(char)} or {@code println(char)} |
2 | 525 |
* methods. |
526 |
* |
|
527 |
* @param b The byte to be written |
|
528 |
* @see #print(char) |
|
529 |
* @see #println(char) |
|
530 |
*/ |
|
58027
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
531 |
@Override |
2 | 532 |
public void write(int b) { |
533 |
try { |
|
534 |
synchronized (this) { |
|
535 |
ensureOpen(); |
|
536 |
out.write(b); |
|
537 |
if ((b == '\n') && autoFlush) |
|
538 |
out.flush(); |
|
539 |
} |
|
540 |
} |
|
541 |
catch (InterruptedIOException x) { |
|
542 |
Thread.currentThread().interrupt(); |
|
543 |
} |
|
544 |
catch (IOException x) { |
|
545 |
trouble = true; |
|
546 |
} |
|
547 |
} |
|
548 |
||
549 |
/** |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
550 |
* Writes {@code len} bytes from the specified byte array starting at |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
551 |
* offset {@code off} to this stream. If automatic flushing is |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
552 |
* enabled then the {@code flush} method will be invoked. |
2 | 553 |
* |
554 |
* <p> Note that the bytes will be written as given; to write characters |
|
555 |
* that will be translated according to the platform's default character |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
556 |
* encoding, use the {@code print(char)} or {@code println(char)} |
2 | 557 |
* methods. |
558 |
* |
|
559 |
* @param buf A byte array |
|
560 |
* @param off Offset from which to start taking bytes |
|
561 |
* @param len Number of bytes to write |
|
562 |
*/ |
|
58027
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
563 |
@Override |
2 | 564 |
public void write(byte buf[], int off, int len) { |
565 |
try { |
|
566 |
synchronized (this) { |
|
567 |
ensureOpen(); |
|
568 |
out.write(buf, off, len); |
|
569 |
if (autoFlush) |
|
570 |
out.flush(); |
|
571 |
} |
|
572 |
} |
|
573 |
catch (InterruptedIOException x) { |
|
574 |
Thread.currentThread().interrupt(); |
|
575 |
} |
|
576 |
catch (IOException x) { |
|
577 |
trouble = true; |
|
578 |
} |
|
579 |
} |
|
580 |
||
58027
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
581 |
/** |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
582 |
* Writes all bytes from the specified byte array to this stream. If |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
583 |
* automatic flushing is enabled then the {@code flush} method will be |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
584 |
* invoked. |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
585 |
* |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
586 |
* <p> Note that the bytes will be written as given; to write characters |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
587 |
* that will be translated according to the platform's default character |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
588 |
* encoding, use the {@code print(char[])} or {@code println(char[])} |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
589 |
* methods. |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
590 |
* |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
591 |
* @apiNote |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
592 |
* Although declared to throw {@code IOException}, this method never |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
593 |
* actually does so. Instead, like other methods that this class |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
594 |
* overrides, it sets an internal flag which may be tested via the |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
595 |
* {@link #checkError()} method. To write an array of bytes without having |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
596 |
* to write a {@code catch} block for the {@code IOException}, use either |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
597 |
* {@link #writeBytes(byte[] buf) writeBytes(buf)} or |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
598 |
* {@link #write(byte[], int, int) write(buf, 0, buf.length)}. |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
599 |
* |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
600 |
* @implSpec |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
601 |
* This method is equivalent to |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
602 |
* {@link java.io.PrintStream#write(byte[],int,int) |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
603 |
* this.write(buf, 0, buf.length)}. |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
604 |
* |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
605 |
* @param buf A byte array |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
606 |
* |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
607 |
* @throws IOException If an I/O error occurs. |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
608 |
* |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
609 |
* @see #writeBytes(byte[]) |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
610 |
* @see #write(byte[],int,int) |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
611 |
* |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
612 |
* @since 14 |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
613 |
*/ |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
614 |
@Override |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
615 |
public void write(byte buf[]) throws IOException { |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
616 |
this.write(buf, 0, buf.length); |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
617 |
} |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
618 |
|
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
619 |
/** |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
620 |
* Writes all bytes from the specified byte array to this stream. |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
621 |
* If automatic flushing is enabled then the {@code flush} method |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
622 |
* will be invoked. |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
623 |
* |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
624 |
* <p> Note that the bytes will be written as given; to write characters |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
625 |
* that will be translated according to the platform's default character |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
626 |
* encoding, use the {@code print(char[])} or {@code println(char[])} |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
627 |
* methods. |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
628 |
* |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
629 |
* @implSpec |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
630 |
* This method is equivalent to |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
631 |
* {@link #write(byte[], int, int) this.write(buf, 0, buf.length)}. |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
632 |
* |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
633 |
* @param buf A byte array |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
634 |
* |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
635 |
* @since 14 |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
636 |
*/ |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
637 |
public void writeBytes(byte buf[]) { |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
638 |
this.write(buf, 0, buf.length); |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
639 |
} |
930551e8ac62
8187898: PrintStream should override FilterOutputStream#write(byte[]) with a method that has no throws clause
bpb
parents:
55727
diff
changeset
|
640 |
|
2 | 641 |
/* |
642 |
* The following private methods on the text- and character-output streams |
|
643 |
* always flush the stream buffers, so that writes to the underlying byte |
|
644 |
* stream occur as promptly as with the original PrintStream. |
|
645 |
*/ |
|
646 |
||
53148 | 647 |
private void write(char[] buf) { |
2 | 648 |
try { |
649 |
synchronized (this) { |
|
650 |
ensureOpen(); |
|
651 |
textOut.write(buf); |
|
652 |
textOut.flushBuffer(); |
|
653 |
charOut.flushBuffer(); |
|
654 |
if (autoFlush) { |
|
655 |
for (int i = 0; i < buf.length; i++) |
|
53148 | 656 |
if (buf[i] == '\n') { |
2 | 657 |
out.flush(); |
53148 | 658 |
break; |
659 |
} |
|
2 | 660 |
} |
661 |
} |
|
53148 | 662 |
} catch (InterruptedIOException x) { |
663 |
Thread.currentThread().interrupt(); |
|
664 |
} catch (IOException x) { |
|
665 |
trouble = true; |
|
666 |
} |
|
667 |
} |
|
668 |
||
669 |
// Used to optimize away back-to-back flushing and synchronization when |
|
670 |
// using println, but since subclasses could exist which depend on |
|
671 |
// observing a call to print followed by newLine() we only use this if |
|
672 |
// getClass() == PrintStream.class to avoid compatibility issues. |
|
673 |
private void writeln(char[] buf) { |
|
674 |
try { |
|
675 |
synchronized (this) { |
|
676 |
ensureOpen(); |
|
677 |
textOut.write(buf); |
|
678 |
textOut.newLine(); |
|
679 |
textOut.flushBuffer(); |
|
680 |
charOut.flushBuffer(); |
|
681 |
if (autoFlush) |
|
682 |
out.flush(); |
|
683 |
} |
|
2 | 684 |
} |
685 |
catch (InterruptedIOException x) { |
|
686 |
Thread.currentThread().interrupt(); |
|
687 |
} |
|
688 |
catch (IOException x) { |
|
689 |
trouble = true; |
|
690 |
} |
|
691 |
} |
|
692 |
||
693 |
private void write(String s) { |
|
694 |
try { |
|
695 |
synchronized (this) { |
|
696 |
ensureOpen(); |
|
697 |
textOut.write(s); |
|
698 |
textOut.flushBuffer(); |
|
699 |
charOut.flushBuffer(); |
|
700 |
if (autoFlush && (s.indexOf('\n') >= 0)) |
|
701 |
out.flush(); |
|
702 |
} |
|
703 |
} |
|
704 |
catch (InterruptedIOException x) { |
|
705 |
Thread.currentThread().interrupt(); |
|
706 |
} |
|
707 |
catch (IOException x) { |
|
708 |
trouble = true; |
|
709 |
} |
|
710 |
} |
|
711 |
||
53148 | 712 |
// Used to optimize away back-to-back flushing and synchronization when |
713 |
// using println, but since subclasses could exist which depend on |
|
714 |
// observing a call to print followed by newLine we only use this if |
|
715 |
// getClass() == PrintStream.class to avoid compatibility issues. |
|
716 |
private void writeln(String s) { |
|
717 |
try { |
|
718 |
synchronized (this) { |
|
719 |
ensureOpen(); |
|
720 |
textOut.write(s); |
|
721 |
textOut.newLine(); |
|
722 |
textOut.flushBuffer(); |
|
723 |
charOut.flushBuffer(); |
|
724 |
if (autoFlush) |
|
725 |
out.flush(); |
|
726 |
} |
|
727 |
} |
|
728 |
catch (InterruptedIOException x) { |
|
729 |
Thread.currentThread().interrupt(); |
|
730 |
} |
|
731 |
catch (IOException x) { |
|
732 |
trouble = true; |
|
733 |
} |
|
734 |
} |
|
735 |
||
2 | 736 |
private void newLine() { |
737 |
try { |
|
738 |
synchronized (this) { |
|
739 |
ensureOpen(); |
|
740 |
textOut.newLine(); |
|
741 |
textOut.flushBuffer(); |
|
742 |
charOut.flushBuffer(); |
|
743 |
if (autoFlush) |
|
744 |
out.flush(); |
|
745 |
} |
|
746 |
} |
|
747 |
catch (InterruptedIOException x) { |
|
748 |
Thread.currentThread().interrupt(); |
|
749 |
} |
|
750 |
catch (IOException x) { |
|
751 |
trouble = true; |
|
752 |
} |
|
753 |
} |
|
754 |
||
755 |
/* Methods that do not terminate lines */ |
|
756 |
||
757 |
/** |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
758 |
* Prints a boolean value. The string produced by {@link |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
759 |
* java.lang.String#valueOf(boolean)} is translated into bytes |
2 | 760 |
* according to the platform's default character encoding, and these bytes |
761 |
* are written in exactly the manner of the |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
762 |
* {@link #write(int)} method. |
2 | 763 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
764 |
* @param b The {@code boolean} to be printed |
2 | 765 |
*/ |
766 |
public void print(boolean b) { |
|
40410 | 767 |
write(String.valueOf(b)); |
2 | 768 |
} |
769 |
||
770 |
/** |
|
771 |
* Prints a character. The character is translated into one or more bytes |
|
55727 | 772 |
* according to the character encoding given to the constructor, or the |
773 |
* platform's default character encoding if none specified. These bytes |
|
774 |
* are written in exactly the manner of the {@link #write(int)} method. |
|
2 | 775 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
776 |
* @param c The {@code char} to be printed |
2 | 777 |
*/ |
778 |
public void print(char c) { |
|
779 |
write(String.valueOf(c)); |
|
780 |
} |
|
781 |
||
782 |
/** |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
783 |
* Prints an integer. The string produced by {@link |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
784 |
* java.lang.String#valueOf(int)} is translated into bytes |
2 | 785 |
* according to the platform's default character encoding, and these bytes |
786 |
* are written in exactly the manner of the |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
787 |
* {@link #write(int)} method. |
2 | 788 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
789 |
* @param i The {@code int} to be printed |
2 | 790 |
* @see java.lang.Integer#toString(int) |
791 |
*/ |
|
792 |
public void print(int i) { |
|
793 |
write(String.valueOf(i)); |
|
794 |
} |
|
795 |
||
796 |
/** |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
797 |
* Prints a long integer. The string produced by {@link |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
798 |
* java.lang.String#valueOf(long)} is translated into bytes |
2 | 799 |
* according to the platform's default character encoding, and these bytes |
800 |
* are written in exactly the manner of the |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
801 |
* {@link #write(int)} method. |
2 | 802 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
803 |
* @param l The {@code long} to be printed |
2 | 804 |
* @see java.lang.Long#toString(long) |
805 |
*/ |
|
806 |
public void print(long l) { |
|
807 |
write(String.valueOf(l)); |
|
808 |
} |
|
809 |
||
810 |
/** |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
811 |
* Prints a floating-point number. The string produced by {@link |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
812 |
* java.lang.String#valueOf(float)} is translated into bytes |
2 | 813 |
* according to the platform's default character encoding, and these bytes |
814 |
* are written in exactly the manner of the |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
815 |
* {@link #write(int)} method. |
2 | 816 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
817 |
* @param f The {@code float} to be printed |
2 | 818 |
* @see java.lang.Float#toString(float) |
819 |
*/ |
|
820 |
public void print(float f) { |
|
821 |
write(String.valueOf(f)); |
|
822 |
} |
|
823 |
||
824 |
/** |
|
825 |
* Prints a double-precision floating-point number. The string produced by |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
826 |
* {@link java.lang.String#valueOf(double)} is translated into |
2 | 827 |
* bytes according to the platform's default character encoding, and these |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
828 |
* bytes are written in exactly the manner of the {@link |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
829 |
* #write(int)} method. |
2 | 830 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
831 |
* @param d The {@code double} to be printed |
2 | 832 |
* @see java.lang.Double#toString(double) |
833 |
*/ |
|
834 |
public void print(double d) { |
|
835 |
write(String.valueOf(d)); |
|
836 |
} |
|
837 |
||
838 |
/** |
|
839 |
* Prints an array of characters. The characters are converted into bytes |
|
55727 | 840 |
* according to the character encoding given to the constructor, or the |
841 |
* platform's default character encoding if none specified. These bytes |
|
842 |
* are written in exactly the manner of the {@link #write(int)} method. |
|
2 | 843 |
* |
844 |
* @param s The array of chars to be printed |
|
845 |
* |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
846 |
* @throws NullPointerException If {@code s} is {@code null} |
2 | 847 |
*/ |
848 |
public void print(char s[]) { |
|
849 |
write(s); |
|
850 |
} |
|
851 |
||
852 |
/** |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
853 |
* Prints a string. If the argument is {@code null} then the string |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
854 |
* {@code "null"} is printed. Otherwise, the string's characters are |
55727 | 855 |
* converted into bytes according to the character encoding given to the |
856 |
* constructor, or the platform's default character encoding if none |
|
857 |
* specified. These bytes are written in exactly the manner of the |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
858 |
* {@link #write(int)} method. |
2 | 859 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
860 |
* @param s The {@code String} to be printed |
2 | 861 |
*/ |
862 |
public void print(String s) { |
|
40410 | 863 |
write(String.valueOf(s)); |
2 | 864 |
} |
865 |
||
866 |
/** |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
867 |
* Prints an object. The string produced by the {@link |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
868 |
* java.lang.String#valueOf(Object)} method is translated into bytes |
2 | 869 |
* according to the platform's default character encoding, and these bytes |
870 |
* are written in exactly the manner of the |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
871 |
* {@link #write(int)} method. |
2 | 872 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
873 |
* @param obj The {@code Object} to be printed |
2 | 874 |
* @see java.lang.Object#toString() |
875 |
*/ |
|
876 |
public void print(Object obj) { |
|
877 |
write(String.valueOf(obj)); |
|
878 |
} |
|
879 |
||
880 |
||
881 |
/* Methods that do terminate lines */ |
|
882 |
||
883 |
/** |
|
884 |
* Terminates the current line by writing the line separator string. The |
|
885 |
* line separator string is defined by the system property |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
886 |
* {@code line.separator}, and is not necessarily a single newline |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
887 |
* character ({@code '\n'}). |
2 | 888 |
*/ |
889 |
public void println() { |
|
890 |
newLine(); |
|
891 |
} |
|
892 |
||
893 |
/** |
|
894 |
* Prints a boolean and then terminate the line. This method behaves as |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
895 |
* though it invokes {@link #print(boolean)} and then |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
896 |
* {@link #println()}. |
2 | 897 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
898 |
* @param x The {@code boolean} to be printed |
2 | 899 |
*/ |
900 |
public void println(boolean x) { |
|
53148 | 901 |
if (getClass() == PrintStream.class) { |
902 |
writeln(String.valueOf(x)); |
|
903 |
} else { |
|
904 |
synchronized (this) { |
|
905 |
print(x); |
|
906 |
newLine(); |
|
907 |
} |
|
2 | 908 |
} |
909 |
} |
|
910 |
||
911 |
/** |
|
912 |
* Prints a character and then terminate the line. This method behaves as |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
913 |
* though it invokes {@link #print(char)} and then |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
914 |
* {@link #println()}. |
2 | 915 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
916 |
* @param x The {@code char} to be printed. |
2 | 917 |
*/ |
918 |
public void println(char x) { |
|
53148 | 919 |
if (getClass() == PrintStream.class) { |
920 |
writeln(String.valueOf(x)); |
|
921 |
} else { |
|
922 |
synchronized (this) { |
|
923 |
print(x); |
|
924 |
newLine(); |
|
925 |
} |
|
2 | 926 |
} |
927 |
} |
|
928 |
||
929 |
/** |
|
930 |
* Prints an integer and then terminate the line. This method behaves as |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
931 |
* though it invokes {@link #print(int)} and then |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
932 |
* {@link #println()}. |
2 | 933 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
934 |
* @param x The {@code int} to be printed. |
2 | 935 |
*/ |
936 |
public void println(int x) { |
|
53148 | 937 |
if (getClass() == PrintStream.class) { |
938 |
writeln(String.valueOf(x)); |
|
939 |
} else { |
|
940 |
synchronized (this) { |
|
941 |
print(x); |
|
942 |
newLine(); |
|
943 |
} |
|
2 | 944 |
} |
945 |
} |
|
946 |
||
947 |
/** |
|
948 |
* Prints a long and then terminate the line. This method behaves as |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
949 |
* though it invokes {@link #print(long)} and then |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
950 |
* {@link #println()}. |
2 | 951 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
952 |
* @param x a The {@code long} to be printed. |
2 | 953 |
*/ |
954 |
public void println(long x) { |
|
53148 | 955 |
if (getClass() == PrintStream.class) { |
956 |
writeln(String.valueOf(x)); |
|
957 |
} else { |
|
958 |
synchronized (this) { |
|
959 |
print(x); |
|
960 |
newLine(); |
|
961 |
} |
|
2 | 962 |
} |
963 |
} |
|
964 |
||
965 |
/** |
|
966 |
* Prints a float and then terminate the line. This method behaves as |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
967 |
* though it invokes {@link #print(float)} and then |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
968 |
* {@link #println()}. |
2 | 969 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
970 |
* @param x The {@code float} to be printed. |
2 | 971 |
*/ |
972 |
public void println(float x) { |
|
53148 | 973 |
if (getClass() == PrintStream.class) { |
974 |
writeln(String.valueOf(x)); |
|
975 |
} else { |
|
976 |
synchronized (this) { |
|
977 |
print(x); |
|
978 |
newLine(); |
|
979 |
} |
|
2 | 980 |
} |
981 |
} |
|
982 |
||
983 |
/** |
|
984 |
* Prints a double and then terminate the line. This method behaves as |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
985 |
* though it invokes {@link #print(double)} and then |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
986 |
* {@link #println()}. |
2 | 987 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
988 |
* @param x The {@code double} to be printed. |
2 | 989 |
*/ |
990 |
public void println(double x) { |
|
53148 | 991 |
if (getClass() == PrintStream.class) { |
992 |
writeln(String.valueOf(x)); |
|
993 |
} else { |
|
994 |
synchronized (this) { |
|
995 |
print(x); |
|
996 |
newLine(); |
|
997 |
} |
|
2 | 998 |
} |
999 |
} |
|
1000 |
||
1001 |
/** |
|
1002 |
* Prints an array of characters and then terminate the line. This method |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1003 |
* behaves as though it invokes {@link #print(char[])} and |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1004 |
* then {@link #println()}. |
2 | 1005 |
* |
1006 |
* @param x an array of chars to print. |
|
1007 |
*/ |
|
53148 | 1008 |
public void println(char[] x) { |
1009 |
if (getClass() == PrintStream.class) { |
|
1010 |
writeln(x); |
|
1011 |
} else { |
|
1012 |
synchronized (this) { |
|
1013 |
print(x); |
|
1014 |
newLine(); |
|
1015 |
} |
|
2 | 1016 |
} |
1017 |
} |
|
1018 |
||
1019 |
/** |
|
1020 |
* Prints a String and then terminate the line. This method behaves as |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1021 |
* though it invokes {@link #print(String)} and then |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1022 |
* {@link #println()}. |
2 | 1023 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1024 |
* @param x The {@code String} to be printed. |
2 | 1025 |
*/ |
1026 |
public void println(String x) { |
|
53148 | 1027 |
if (getClass() == PrintStream.class) { |
1028 |
writeln(String.valueOf(x)); |
|
1029 |
} else { |
|
1030 |
synchronized (this) { |
|
1031 |
print(x); |
|
1032 |
newLine(); |
|
1033 |
} |
|
2 | 1034 |
} |
1035 |
} |
|
1036 |
||
1037 |
/** |
|
1038 |
* Prints an Object and then terminate the line. This method calls |
|
1039 |
* at first String.valueOf(x) to get the printed object's string value, |
|
1040 |
* then behaves as |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1041 |
* though it invokes {@link #print(String)} and then |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1042 |
* {@link #println()}. |
2 | 1043 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1044 |
* @param x The {@code Object} to be printed. |
2 | 1045 |
*/ |
1046 |
public void println(Object x) { |
|
1047 |
String s = String.valueOf(x); |
|
53148 | 1048 |
if (getClass() == PrintStream.class) { |
1049 |
// need to apply String.valueOf again since first invocation |
|
1050 |
// might return null |
|
1051 |
writeln(String.valueOf(s)); |
|
1052 |
} else { |
|
1053 |
synchronized (this) { |
|
1054 |
print(s); |
|
1055 |
newLine(); |
|
1056 |
} |
|
2 | 1057 |
} |
1058 |
} |
|
1059 |
||
1060 |
||
1061 |
/** |
|
1062 |
* A convenience method to write a formatted string to this output stream |
|
1063 |
* using the specified format string and arguments. |
|
1064 |
* |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1065 |
* <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
|
1066 |
* {@code out.printf(format, args)} behaves |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1067 |
* in exactly the same way as the invocation |
2 | 1068 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1069 |
* <pre>{@code |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1070 |
* out.format(format, args) |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1071 |
* }</pre> |
2 | 1072 |
* |
1073 |
* @param format |
|
1074 |
* A format string as described in <a |
|
1075 |
* href="../util/Formatter.html#syntax">Format string syntax</a> |
|
1076 |
* |
|
1077 |
* @param args |
|
1078 |
* Arguments referenced by the format specifiers in the format |
|
1079 |
* string. If there are more arguments than format specifiers, the |
|
1080 |
* extra arguments are ignored. The number of arguments is |
|
1081 |
* variable and may be zero. The maximum number of arguments is |
|
1082 |
* limited by the maximum dimension of a Java array as defined by |
|
9266
121fb370f179
7032960: API files in java.awt need to be updated for references to JVM Spec with editions/hyperlinks
jjh
parents:
8166
diff
changeset
|
1083 |
* <cite>The Java™ Virtual Machine Specification</cite>. |
121fb370f179
7032960: API files in java.awt need to be updated for references to JVM Spec with editions/hyperlinks
jjh
parents:
8166
diff
changeset
|
1084 |
* The behaviour on a |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1085 |
* {@code null} argument depends on the <a |
2 | 1086 |
* href="../util/Formatter.html#syntax">conversion</a>. |
1087 |
* |
|
18156 | 1088 |
* @throws java.util.IllegalFormatException |
2 | 1089 |
* If a format string contains an illegal syntax, a format |
1090 |
* specifier that is incompatible with the given arguments, |
|
1091 |
* insufficient arguments given the format string, or other |
|
1092 |
* illegal conditions. For specification of all possible |
|
1093 |
* formatting errors, see the <a |
|
1094 |
* href="../util/Formatter.html#detail">Details</a> section of the |
|
1095 |
* formatter class specification. |
|
1096 |
* |
|
1097 |
* @throws NullPointerException |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1098 |
* If the {@code format} is {@code null} |
2 | 1099 |
* |
1100 |
* @return This output stream |
|
1101 |
* |
|
1102 |
* @since 1.5 |
|
1103 |
*/ |
|
1104 |
public PrintStream printf(String format, Object ... args) { |
|
1105 |
return format(format, args); |
|
1106 |
} |
|
1107 |
||
1108 |
/** |
|
1109 |
* A convenience method to write a formatted string to this output stream |
|
1110 |
* using the specified format string and arguments. |
|
1111 |
* |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1112 |
* <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
|
1113 |
* {@code out.printf(l, format, args)} behaves |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1114 |
* in exactly the same way as the invocation |
2 | 1115 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1116 |
* <pre>{@code |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1117 |
* out.format(l, format, args) |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1118 |
* }</pre> |
2 | 1119 |
* |
1120 |
* @param l |
|
1121 |
* The {@linkplain java.util.Locale locale} to apply during |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1122 |
* formatting. If {@code l} is {@code null} then no localization |
2 | 1123 |
* is applied. |
1124 |
* |
|
1125 |
* @param format |
|
1126 |
* A format string as described in <a |
|
1127 |
* href="../util/Formatter.html#syntax">Format string syntax</a> |
|
1128 |
* |
|
1129 |
* @param args |
|
1130 |
* Arguments referenced by the format specifiers in the format |
|
1131 |
* string. If there are more arguments than format specifiers, the |
|
1132 |
* extra arguments are ignored. The number of arguments is |
|
1133 |
* variable and may be zero. The maximum number of arguments is |
|
1134 |
* limited by the maximum dimension of a Java array as defined by |
|
9266
121fb370f179
7032960: API files in java.awt need to be updated for references to JVM Spec with editions/hyperlinks
jjh
parents:
8166
diff
changeset
|
1135 |
* <cite>The Java™ Virtual Machine Specification</cite>. |
121fb370f179
7032960: API files in java.awt need to be updated for references to JVM Spec with editions/hyperlinks
jjh
parents:
8166
diff
changeset
|
1136 |
* The behaviour on a |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1137 |
* {@code null} argument depends on the <a |
2 | 1138 |
* href="../util/Formatter.html#syntax">conversion</a>. |
1139 |
* |
|
18156 | 1140 |
* @throws java.util.IllegalFormatException |
2 | 1141 |
* If a format string contains an illegal syntax, a format |
1142 |
* specifier that is incompatible with the given arguments, |
|
1143 |
* insufficient arguments given the format string, or other |
|
1144 |
* illegal conditions. For specification of all possible |
|
1145 |
* formatting errors, see the <a |
|
1146 |
* href="../util/Formatter.html#detail">Details</a> section of the |
|
1147 |
* formatter class specification. |
|
1148 |
* |
|
1149 |
* @throws NullPointerException |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1150 |
* If the {@code format} is {@code null} |
2 | 1151 |
* |
1152 |
* @return This output stream |
|
1153 |
* |
|
1154 |
* @since 1.5 |
|
1155 |
*/ |
|
1156 |
public PrintStream printf(Locale l, String format, Object ... args) { |
|
1157 |
return format(l, format, args); |
|
1158 |
} |
|
1159 |
||
1160 |
/** |
|
1161 |
* Writes a formatted string to this output stream using the specified |
|
1162 |
* format string and arguments. |
|
1163 |
* |
|
1164 |
* <p> The locale always used is the one returned by {@link |
|
38786
8e7b0ac05815
8146156: Inconsistent default locale in string formatter methods
naoto
parents:
32033
diff
changeset
|
1165 |
* java.util.Locale#getDefault(Locale.Category)} with |
8e7b0ac05815
8146156: Inconsistent default locale in string formatter methods
naoto
parents:
32033
diff
changeset
|
1166 |
* {@link java.util.Locale.Category#FORMAT FORMAT} category specified, |
8e7b0ac05815
8146156: Inconsistent default locale in string formatter methods
naoto
parents:
32033
diff
changeset
|
1167 |
* regardless of any previous invocations of other formatting methods on |
8e7b0ac05815
8146156: Inconsistent default locale in string formatter methods
naoto
parents:
32033
diff
changeset
|
1168 |
* this object. |
2 | 1169 |
* |
1170 |
* @param format |
|
1171 |
* A format string as described in <a |
|
1172 |
* href="../util/Formatter.html#syntax">Format string syntax</a> |
|
1173 |
* |
|
1174 |
* @param args |
|
1175 |
* Arguments referenced by the format specifiers in the format |
|
1176 |
* string. If there are more arguments than format specifiers, the |
|
1177 |
* extra arguments are ignored. The number of arguments is |
|
1178 |
* variable and may be zero. The maximum number of arguments is |
|
1179 |
* limited by the maximum dimension of a Java array as defined by |
|
9266
121fb370f179
7032960: API files in java.awt need to be updated for references to JVM Spec with editions/hyperlinks
jjh
parents:
8166
diff
changeset
|
1180 |
* <cite>The Java™ Virtual Machine Specification</cite>. |
121fb370f179
7032960: API files in java.awt need to be updated for references to JVM Spec with editions/hyperlinks
jjh
parents:
8166
diff
changeset
|
1181 |
* The behaviour on a |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1182 |
* {@code null} argument depends on the <a |
2 | 1183 |
* href="../util/Formatter.html#syntax">conversion</a>. |
1184 |
* |
|
18156 | 1185 |
* @throws java.util.IllegalFormatException |
2 | 1186 |
* If a format string contains an illegal syntax, a format |
1187 |
* specifier that is incompatible with the given arguments, |
|
1188 |
* insufficient arguments given the format string, or other |
|
1189 |
* illegal conditions. For specification of all possible |
|
1190 |
* formatting errors, see the <a |
|
1191 |
* href="../util/Formatter.html#detail">Details</a> section of the |
|
1192 |
* formatter class specification. |
|
1193 |
* |
|
1194 |
* @throws NullPointerException |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1195 |
* If the {@code format} is {@code null} |
2 | 1196 |
* |
1197 |
* @return This output stream |
|
1198 |
* |
|
1199 |
* @since 1.5 |
|
1200 |
*/ |
|
1201 |
public PrintStream format(String format, Object ... args) { |
|
1202 |
try { |
|
1203 |
synchronized (this) { |
|
1204 |
ensureOpen(); |
|
1205 |
if ((formatter == null) |
|
38786
8e7b0ac05815
8146156: Inconsistent default locale in string formatter methods
naoto
parents:
32033
diff
changeset
|
1206 |
|| (formatter.locale() != |
8e7b0ac05815
8146156: Inconsistent default locale in string formatter methods
naoto
parents:
32033
diff
changeset
|
1207 |
Locale.getDefault(Locale.Category.FORMAT))) |
2 | 1208 |
formatter = new Formatter((Appendable) this); |
38786
8e7b0ac05815
8146156: Inconsistent default locale in string formatter methods
naoto
parents:
32033
diff
changeset
|
1209 |
formatter.format(Locale.getDefault(Locale.Category.FORMAT), |
8e7b0ac05815
8146156: Inconsistent default locale in string formatter methods
naoto
parents:
32033
diff
changeset
|
1210 |
format, args); |
2 | 1211 |
} |
1212 |
} catch (InterruptedIOException x) { |
|
1213 |
Thread.currentThread().interrupt(); |
|
1214 |
} catch (IOException x) { |
|
1215 |
trouble = true; |
|
1216 |
} |
|
1217 |
return this; |
|
1218 |
} |
|
1219 |
||
1220 |
/** |
|
1221 |
* Writes a formatted string to this output stream using the specified |
|
1222 |
* format string and arguments. |
|
1223 |
* |
|
1224 |
* @param l |
|
1225 |
* The {@linkplain java.util.Locale locale} to apply during |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1226 |
* formatting. If {@code l} is {@code null} then no localization |
2 | 1227 |
* is applied. |
1228 |
* |
|
1229 |
* @param format |
|
1230 |
* A format string as described in <a |
|
1231 |
* href="../util/Formatter.html#syntax">Format string syntax</a> |
|
1232 |
* |
|
1233 |
* @param args |
|
1234 |
* Arguments referenced by the format specifiers in the format |
|
1235 |
* string. If there are more arguments than format specifiers, the |
|
1236 |
* extra arguments are ignored. The number of arguments is |
|
1237 |
* variable and may be zero. The maximum number of arguments is |
|
1238 |
* limited by the maximum dimension of a Java array as defined by |
|
9266
121fb370f179
7032960: API files in java.awt need to be updated for references to JVM Spec with editions/hyperlinks
jjh
parents:
8166
diff
changeset
|
1239 |
* <cite>The Java™ Virtual Machine Specification</cite>. |
121fb370f179
7032960: API files in java.awt need to be updated for references to JVM Spec with editions/hyperlinks
jjh
parents:
8166
diff
changeset
|
1240 |
* The behaviour on a |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1241 |
* {@code null} argument depends on the <a |
2 | 1242 |
* href="../util/Formatter.html#syntax">conversion</a>. |
1243 |
* |
|
18156 | 1244 |
* @throws java.util.IllegalFormatException |
2 | 1245 |
* If a format string contains an illegal syntax, a format |
1246 |
* specifier that is incompatible with the given arguments, |
|
1247 |
* insufficient arguments given the format string, or other |
|
1248 |
* illegal conditions. For specification of all possible |
|
1249 |
* formatting errors, see the <a |
|
1250 |
* href="../util/Formatter.html#detail">Details</a> section of the |
|
1251 |
* formatter class specification. |
|
1252 |
* |
|
1253 |
* @throws NullPointerException |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1254 |
* If the {@code format} is {@code null} |
2 | 1255 |
* |
1256 |
* @return This output stream |
|
1257 |
* |
|
1258 |
* @since 1.5 |
|
1259 |
*/ |
|
1260 |
public PrintStream format(Locale l, String format, Object ... args) { |
|
1261 |
try { |
|
1262 |
synchronized (this) { |
|
1263 |
ensureOpen(); |
|
1264 |
if ((formatter == null) |
|
1265 |
|| (formatter.locale() != l)) |
|
1266 |
formatter = new Formatter(this, l); |
|
1267 |
formatter.format(l, format, args); |
|
1268 |
} |
|
1269 |
} catch (InterruptedIOException x) { |
|
1270 |
Thread.currentThread().interrupt(); |
|
1271 |
} catch (IOException x) { |
|
1272 |
trouble = true; |
|
1273 |
} |
|
1274 |
return this; |
|
1275 |
} |
|
1276 |
||
1277 |
/** |
|
1278 |
* Appends the specified character sequence to this output stream. |
|
1279 |
* |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1280 |
* <p> An invocation of this method of the form {@code out.append(csq)} |
2 | 1281 |
* behaves in exactly the same way as the invocation |
1282 |
* |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1283 |
* <pre>{@code |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1284 |
* out.print(csq.toString()) |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1285 |
* }</pre> |
2 | 1286 |
* |
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1287 |
* <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
|
1288 |
* 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
|
1289 |
* appended. For instance, invoking then {@code toString} method of a |
2 | 1290 |
* character buffer will return a subsequence whose content depends upon |
1291 |
* the buffer's position and limit. |
|
1292 |
* |
|
1293 |
* @param csq |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1294 |
* 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
|
1295 |
* {@code null}, then the four characters {@code "null"} are |
2 | 1296 |
* appended to this output stream. |
1297 |
* |
|
1298 |
* @return This output stream |
|
1299 |
* |
|
1300 |
* @since 1.5 |
|
1301 |
*/ |
|
1302 |
public PrintStream append(CharSequence csq) { |
|
40410 | 1303 |
print(String.valueOf(csq)); |
2 | 1304 |
return this; |
1305 |
} |
|
1306 |
||
1307 |
/** |
|
1308 |
* Appends a subsequence of the specified character sequence to this output |
|
1309 |
* stream. |
|
1310 |
* |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1311 |
* <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
|
1312 |
* {@code out.append(csq, start, end)} when |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1313 |
* {@code csq} is not {@code null}, behaves in |
2 | 1314 |
* exactly the same way as the invocation |
1315 |
* |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1316 |
* <pre>{@code |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1317 |
* out.print(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
|
1318 |
* }</pre> |
2 | 1319 |
* |
1320 |
* @param csq |
|
1321 |
* 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
|
1322 |
* 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
|
1323 |
* 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
|
1324 |
* characters {@code "null"}. |
2 | 1325 |
* |
1326 |
* @param start |
|
1327 |
* The index of the first character in the subsequence |
|
1328 |
* |
|
1329 |
* @param end |
|
1330 |
* The index of the character following the last character in the |
|
1331 |
* subsequence |
|
1332 |
* |
|
1333 |
* @return This output stream |
|
1334 |
* |
|
1335 |
* @throws IndexOutOfBoundsException |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1336 |
* 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
|
1337 |
* 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
|
1338 |
* {@code csq.length()} |
2 | 1339 |
* |
1340 |
* @since 1.5 |
|
1341 |
*/ |
|
1342 |
public PrintStream append(CharSequence csq, int start, int end) { |
|
40410 | 1343 |
if (csq == null) csq = "null"; |
1344 |
return append(csq.subSequence(start, end)); |
|
2 | 1345 |
} |
1346 |
||
1347 |
/** |
|
1348 |
* Appends the specified character to this output stream. |
|
1349 |
* |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1350 |
* <p> An invocation of this method of the form {@code out.append(c)} |
2 | 1351 |
* behaves in exactly the same way as the invocation |
1352 |
* |
|
32033
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1353 |
* <pre>{@code |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1354 |
* out.print(c) |
bf24e33c7919
8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents:
25859
diff
changeset
|
1355 |
* }</pre> |
2 | 1356 |
* |
1357 |
* @param c |
|
1358 |
* The 16-bit character to append |
|
1359 |
* |
|
1360 |
* @return This output stream |
|
1361 |
* |
|
1362 |
* @since 1.5 |
|
1363 |
*/ |
|
1364 |
public PrintStream append(char c) { |
|
1365 |
print(c); |
|
1366 |
return this; |
|
1367 |
} |
|
1368 |
||
1369 |
} |