| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
OutputStream os = …;
String charsetName = …;
OutputStreamWriter osw = new OutputStreamWriter(os, charsetName);
Based on 13 examples
ByteArrayOutputStream output = …;
OutputStreamWriter out = new OutputStreamWriter(output);
Based on 12 examples
FileOutputStream fout = …;
OutputStreamWriter osw = new OutputStreamWriter(fout, "MacSymbol");
Based on 11 examples
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 {@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'.
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 {@linkplain java.nio.charset.CharsetEncoder} class should be used when more control over the encoding process is required.
Field Summary |
---|
Fields inherited from class java.io.Writer |
---|
lock |
Constructor Summary | |
---|---|
Creates an OutputStreamWriter that uses the default character encoding. |
|
OutputStreamWriter(OutputStream out, Charset cs) Creates an OutputStreamWriter that uses the given charset. |
|
OutputStreamWriter(OutputStream out, CharsetEncoder enc) Creates an OutputStreamWriter that uses the given charset encoder. |
|
OutputStreamWriter(OutputStream out, String charsetName) Creates an OutputStreamWriter that uses the named charset. |
Method Summary | |
---|---|
void |
close() Closes the stream, flushing it first. |
void |
flush() Flushes the stream. |
String |
Returns the name of the character encoding being used by this stream. |
void |
write(char[] cbuf, int off, int len) Writes a portion of an array of characters. |
void |
write(int c) Writes a single character. |
void |
Writes a portion of a string. |
Methods inherited from class java.io.Writer |
---|
append, append, append, close, flush, write, write, write, write, write |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public OutputStreamWriter(OutputStream out)
out
- An OutputStreampublic OutputStreamWriter(OutputStream out, Charset cs)
out
- An OutputStreamcs
- A charsetpublic OutputStreamWriter(OutputStream out, CharsetEncoder enc)
out
- An OutputStreamenc
- A charset encoderpublic OutputStreamWriter(OutputStream out, String charsetName) throws UnsupportedEncodingException
out
- An OutputStreamcharsetName
- The name of a supported
{@link java.nio.charset.Charset charset}
UnsupportedEncodingException
- If the named encoding is not supportedMethod Detail |
---|
public void close() throws IOException
close
in class Writer
IOException
public void flush() throws IOException
flush
in class Writer
IOException
- If an I/O error occurspublic 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 {@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.
null
if the stream has been closedpublic 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 writeIOException
- If an I/O error occurspublic void write(int c) throws IOException
write
in class Writer
c
IOException
- 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 writeIOException
- If an I/O error occurs
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |