public class OutputStreamWriter extends Writer
An OutputStreamWriter is a bridge from character streams to byte streams: Characters written to it are encoded into bytes using a specified charset. The charset that it uses may be specified by name or may be given explicitly, or the platform's 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. The size of this buffer may be specified, but by default it is large enough for most purposes. 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(System.out));
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.
BufferedWriter, OutputStream, Charset
lock public OutputStreamWriter(OutputStream out,
String charsetName)
throws UnsupportedEncodingException Creates an OutputStreamWriter that uses the named charset.
out - An OutputStreamcharsetName - The name of a supported charset
UnsupportedEncodingException - If the named encoding is not supportedpublic OutputStreamWriter(OutputStream out)
Creates an OutputStreamWriter that uses the default character encoding.
out - An OutputStreampublic OutputStreamWriter(OutputStream out,
Charset cs) Creates an OutputStreamWriter that uses the given charset.
out - An OutputStreamcs - A charsetpublic OutputStreamWriter(OutputStream out,
CharsetEncoder enc) Creates an OutputStreamWriter that uses the given charset encoder.
out - An OutputStreamenc - A charset encoderpublic String getEncoding()
Returns the name of the character encoding being used by this stream.
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 closedCharsetpublic void write(int c)
throws IOException Writes a single character.
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 Writes a portion of an array of characters.
write in class Writer
cbuf - Buffer of charactersoff - Offset from which to start writing characterslen - Number of characters to writeIOException - If an I/O error occurspublic void write(String str,
int off,
int len)
throws IOException Writes a portion of a string.
write in class Writer
str - A Stringoff - Offset from which to start writing characterslen - Number of characters to writeIOException - If an I/O error occurspublic void flush()
throws IOException Flushes the stream.
flush in interface Flushable
flush in class Writer
IOException - If an I/O error occurspublic void close()
throws IOException Description copied from class: Writer
Closes the stream, flushing it first. Once the stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously closed stream has no effect.
close in interface Closeable
close in interface AutoCloseable
close in class Writer
IOException - If an I/O error occurs
© 1993–2017, 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.