Class OutputStreamWriter
- All Implemented Interfaces:
Closeable
,Flushable
,Appendable
,AutoCloseable
- Direct Known Subclasses:
FileWriter
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.
- Since:
- 1.1
- See Also:
-
Field Summary
-
Constructor Summary
ConstructorDescriptionCreates an OutputStreamWriter that uses the default character encoding, or whereout
is aPrintStream
, the charset used by the print stream.OutputStreamWriter
(OutputStream out, String charsetName) Creates an OutputStreamWriter that uses the named charset.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. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Closes the stream, flushing it first.void
flush()
Flushes the stream.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.
-
Constructor Details
-
OutputStreamWriter
Creates an OutputStreamWriter that uses the named charset.- Parameters:
out
- An OutputStreamcharsetName
- The name of a supportedcharset
- Throws:
UnsupportedEncodingException
- If the named encoding is not supported
-
OutputStreamWriter
Creates an OutputStreamWriter that uses the default character encoding, or whereout
is aPrintStream
, the charset used by the print stream.- Parameters:
out
- An OutputStream- See Also:
-
OutputStreamWriter
Creates an OutputStreamWriter that uses the given charset.- Parameters:
out
- An OutputStreamcs
- A charset- Since:
- 1.4
-
OutputStreamWriter
Creates an OutputStreamWriter that uses the given charset encoder.- Parameters:
out
- An OutputStreamenc
- A charset encoder- Since:
- 1.4
-
-
Method Details
-
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 returnnull
if the stream has been closed.- Returns:
- The historical name of this encoding, or possibly
null
if the stream has been closed - See Also:
-
write
Writes a single character.- Overrides:
write
in classWriter
- Parameters:
c
- int specifying a character to be written- Throws:
IOException
- If an I/O error occurs
-
write
Writes a portion of an array of characters.- Specified by:
write
in classWriter
- Parameters:
cbuf
- Buffer of charactersoff
- Offset from which to start writing characterslen
- Number of characters to write- Throws:
IndexOutOfBoundsException
- Ifoff
is negative, orlen
is negative, oroff + len
is negative or greater than the length of the given arrayIOException
- If an I/O error occurs
-
write
Writes a portion of a string.- Overrides:
write
in classWriter
- Parameters:
str
- A Stringoff
- Offset from which to start writing characterslen
- Number of characters to write- Throws:
IndexOutOfBoundsException
- Ifoff
is negative, orlen
is negative, oroff + len
is negative or greater than the length of the given stringIOException
- If an I/O error occurs
-
flush
Flushes the stream.- Specified by:
flush
in interfaceFlushable
- Specified by:
flush
in classWriter
- Throws:
IOException
- If an I/O error occurs
-
close
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.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classWriter
- Throws:
IOException
- If an I/O error occurs
-