| |
|
| java.lang.Object
 java.io.Writer
java.io.OutputStreamWriter
All known Subclasses: java.io.FileWriter,
| OutputStreamWriter | | public class OutputStreamWriter extends Writer (Code) | | An OutputStreamWriter is a bridge from character streams to byte streams:
Characters written to it are encoded into bytes using a specified
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
class should be used when more
control over the encoding process is required.
See Also: BufferedWriter
See Also: OutputStream
See Also: java.nio.charset.Charset
version:
1.56, 07/05/05
author:
Mark Reinhold
since:
JDK1.1 |
| Method Summary | |
| public void | close()
| | public void | flush()
Flushes the stream. | | void | flushBuffer()
Flushes the output buffer to the underlying byte stream, without flushing
the byte stream itself. | | public 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.OutputStreamWriter(OutputStream,String) constructor then the returned
name, being unique for the encoding, may differ from the name passed to
the constructor. | | public void | write(int c)
Writes a single character. | | public void | write(char cbuf, int off, int len)
Writes a portion of an array of characters. | | public void | write(String str, int off, int len)
Writes a portion of a string. |
| OutputStreamWriter | | public OutputStreamWriter(OutputStream out)(Code) | | Creates an OutputStreamWriter that uses the default character encoding.
Parameters:
out - An OutputStream |
| OutputStreamWriter | | public OutputStreamWriter(OutputStream out, Charset cs)(Code) | | Creates an OutputStreamWriter that uses the given charset.
Parameters:
out - An OutputStream
Parameters:
cs - A charset
since:
1.4 |
| OutputStreamWriter | | public OutputStreamWriter(OutputStream out, CharsetEncoder enc)(Code) | | Creates an OutputStreamWriter that uses the given charset encoder.
Parameters:
out - An OutputStream
Parameters:
enc - A charset encoder
since:
1.4 |
| flushBuffer | | void flushBuffer() throws IOException(Code) | | Flushes 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.
|
| getEncoding | | public String getEncoding()(Code) | | 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.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.
The historical name of this encoding, or possiblynull if the stream has been closed
See Also: java.nio.charset.Charset |
| write | | public void write(char cbuf, int off, int len) throws IOException(Code) | | Writes a portion of an array of characters.
Parameters:
cbuf - Buffer of characters
Parameters:
off - Offset from which to start writing characters
Parameters:
len - Number of characters to write
exception:
IOException - If an I/O error occurs |
| write | | public void write(String str, int off, int len) throws IOException(Code) | | Writes a portion of a string.
Parameters:
str - A String
Parameters:
off - Offset from which to start writing characters
Parameters:
len - Number of characters to write
exception:
IOException - If an I/O error occurs |
|
|
|