Closeable, Flushable, Appendable, AutoCloseable
FileWriterpublic class OutputStreamWriter extends Writer
charset. The charset that it uses may be specified by name or may be given explicitly, or the default charset may be accepted. Each invocation of a write() method causes the encoding converter to be invoked on the given character(s). The resulting bytes are accumulated in a buffer before being written to the underlying output stream. Note that the characters passed to the write() methods are not buffered.
For top efficiency, consider wrapping an OutputStreamWriter within a BufferedWriter so as to avoid frequent converter invocations. For example:
Writer out = new BufferedWriter(new OutputStreamWriter(anOutputStream));
A surrogate pair is a character represented by a sequence of two char values: A high surrogate in the range '\uD800' to '\uDBFF' followed by a low surrogate in the range '\uDC00' to '\uDFFF'.
A malformed surrogate element is a high surrogate that is not followed by a low surrogate or a low surrogate that is not preceded by a high surrogate.
This class always replaces malformed surrogate elements and unmappable character sequences with the charset's default substitution sequence. The CharsetEncoder class should be used when more control over the encoding process is required.
| Constructor | Description |
|---|---|
OutputStreamWriter |
Creates an OutputStreamWriter that uses the default character encoding, or where out is a PrintStream, the charset used by the print stream. |
OutputStreamWriter |
Creates an OutputStreamWriter that uses the named charset. |
OutputStreamWriter |
Creates an OutputStreamWriter that uses the given charset. |
OutputStreamWriter |
Creates an OutputStreamWriter that uses the given charset encoder. |
| Modifier and Type | Method | Description |
|---|---|---|
void |
close() |
Closes the stream, flushing it first. |
void |
flush() |
Flushes the stream. |
String |
getEncoding() |
Returns the name of the character encoding being used by this stream. |
void |
write |
Writes a portion of an array of characters. |
void |
write |
Writes a single character. |
void |
write |
Writes a portion of a string. |
public OutputStreamWriter(OutputStream out, String charsetName) throws UnsupportedEncodingException
out - An OutputStreamcharsetName - The name of a supported charset
UnsupportedEncodingException - If the named encoding is not supportedpublic OutputStreamWriter(OutputStream out)
out is a PrintStream, the charset used by the print stream.out - An OutputStreampublic OutputStreamWriter(OutputStream out, Charset cs)
out - An OutputStreamcs - A charsetpublic OutputStreamWriter(OutputStream out, CharsetEncoder enc)
out - An OutputStreamenc - A charset encoderpublic String getEncoding()
If the encoding has an historical name then that name is returned; otherwise the encoding's canonical name is returned.
If this instance was created with the OutputStreamWriter(OutputStream, String) constructor then the returned name, being unique for the encoding, may differ from the name passed to the constructor. This method may return null if the stream has been closed.
null if the stream has been closedpublic void write(int c) throws IOException
write in class Writer
c - int specifying a character to be writtenIOException - If an I/O error occurspublic void write(char[] cbuf, int off, int len) throws IOException
write in class Writer
cbuf - Buffer of charactersoff - Offset from which to start writing characterslen - Number of characters to writeIndexOutOfBoundsException - If off is negative, or len is negative, or off + len is negative or greater than the length of the given arrayIOException - If an I/O error occurspublic void write(String str, int off, int len) throws IOException
write in class Writer
str - A Stringoff - Offset from which to start writing characterslen - Number of characters to writeIndexOutOfBoundsException - If off is negative, or len is negative, or off + len is negative or greater than the length of the given stringIOException - If an I/O error occurspublic void flush() throws IOException
flush in interface Flushable
flush in class Writer
IOException - If an I/O error occurspublic void close() throws IOException
Writerclose in interface AutoCloseable
close in interface Closeable
close in class Writer
IOException - If an I/O error occurs
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/OutputStreamWriter.html