OutputStreamWriterpublic 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 {@link
java.nio.charset.Charset 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'. If the character represented by a surrogate pair cannot be
encoded by a given charset then a charset-dependent substitution
sequence is written to the output stream.
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. It is illegal to attempt to write a character stream
containing malformed surrogate elements. The behavior of an instance of
this class when a malformed surrogate element is written is not specified. |
| Fields Summary |
|---|
| private final StreamEncoder | se |
| Constructors Summary |
|---|
public OutputStreamWriter(OutputStream out, String charsetName)Create an OutputStreamWriter that uses the named charset.
super(out);
if (charsetName == null)
throw new NullPointerException("charsetName");
se = StreamEncoder.forOutputStreamWriter(out, this, charsetName);
| public OutputStreamWriter(OutputStream out)Create an OutputStreamWriter that uses the default character encoding.
super(out);
try {
se = StreamEncoder.forOutputStreamWriter(out, this, (String)null);
} catch (UnsupportedEncodingException e) {
throw new Error(e);
}
| public OutputStreamWriter(OutputStream out, Charset cs)Create an OutputStreamWriter that uses the given charset.
super(out);
if (cs == null)
throw new NullPointerException("charset");
se = StreamEncoder.forOutputStreamWriter(out, this, cs);
| public OutputStreamWriter(OutputStream out, CharsetEncoder enc)Create an OutputStreamWriter that uses the given charset encoder.
super(out);
if (enc == null)
throw new NullPointerException("charset encoder");
se = StreamEncoder.forOutputStreamWriter(out, this, enc);
|
| Methods Summary |
|---|
| public void | close()Close the stream.
se.close();
| | public void | flush()Flush the stream.
se.flush();
| | void | flushBuffer()Flush the output buffer to the underlying byte stream, without flushing
the byte stream itself. This method is non-private only so that it may
be invoked by PrintStream.
se.flushBuffer();
| | public java.lang.String | getEncoding()Return 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 {@link
#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.
return se.getEncoding();
| | public void | write(int c)Write a single character.
se.write(c);
| | public void | write(char[] cbuf, int off, int len)Write a portion of an array of characters.
se.write(cbuf, off, len);
| | public void | write(java.lang.String str, int off, int len)Write a portion of a string.
se.write(str, off, len);
|
|
