- java.lang.Object
- 
- java.io.Writer
- 
- java.io.OutputStreamWriter
 
 
- 
- All Implemented Interfaces:
- Closeable,- Flushable,- Appendable,- AutoCloseable
 - Direct Known Subclasses:
- FileWriter
 
 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 specifiedcharset. 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. 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 charvalues: 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:
- BufferedWriter,- OutputStream,- Charset
 
- 
- 
Constructor SummaryConstructors Constructor Description OutputStreamWriter(OutputStream out)Creates an OutputStreamWriter that uses the default character encoding.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 SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidflush()Flushes the stream.StringgetEncoding()Returns the name of the character encoding being used by this stream.voidwrite(char[] cbuf, int off, int len)Writes a portion of an array of characters.voidwrite(int c)Writes a single character.voidwrite(String str, int off, int len)Writes a portion of a string.
 
- 
- 
- 
Constructor Detail- 
OutputStreamWriterpublic OutputStreamWriter(OutputStream out, String charsetName) throws UnsupportedEncodingException Creates an OutputStreamWriter that uses the named charset.- Parameters:
- out- An OutputStream
- charsetName- The name of a supported- charset
- Throws:
- UnsupportedEncodingException- If the named encoding is not supported
 
 - 
OutputStreamWriterpublic OutputStreamWriter(OutputStream out) Creates an OutputStreamWriter that uses the default character encoding.- Parameters:
- out- An OutputStream
 
 - 
OutputStreamWriterpublic OutputStreamWriter(OutputStream out, Charset cs) Creates an OutputStreamWriter that uses the given charset.- Parameters:
- out- An OutputStream
- cs- A charset
- Since:
- 1.4
 
 - 
OutputStreamWriterpublic OutputStreamWriter(OutputStream out, CharsetEncoder enc) Creates an OutputStreamWriter that uses the given charset encoder.- Parameters:
- out- An OutputStream
- enc- A charset encoder
- Since:
- 1.4
 
 
- 
 - 
Method Detail- 
getEncodingpublic 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 returnnullif the stream has been closed.- Returns:
- The historical name of this encoding, or possibly
         nullif the stream has been closed
- See Also:
- Charset
 
 - 
writepublic void write(int c) throws IOExceptionWrites a single character.- Overrides:
- writein class- Writer
- Parameters:
- c- int specifying a character to be written
- Throws:
- IOException- If an I/O error occurs
 
 - 
writepublic void write(char[] cbuf, int off, int len) throws IOExceptionWrites a portion of an array of characters.- Specified by:
- writein class- Writer
- Parameters:
- cbuf- Buffer of characters
- off- Offset from which to start writing characters
- len- Number of characters to write
- Throws:
- IndexOutOfBoundsException- If- offis negative, or- lenis negative, or- off + lenis negative or greater than the length of the given array
- IOException- If an I/O error occurs
 
 - 
writepublic void write(String str, int off, int len) throws IOException Writes a portion of a string.- Overrides:
- writein class- Writer
- Parameters:
- str- A String
- off- Offset from which to start writing characters
- len- Number of characters to write
- Throws:
- IndexOutOfBoundsException- If- offis negative, or- lenis negative, or- off + lenis negative or greater than the length of the given string
- IOException- If an I/O error occurs
 
 - 
flushpublic void flush() throws IOExceptionFlushes the stream.- Specified by:
- flushin interface- Flushable
- Specified by:
- flushin class- Writer
- Throws:
- IOException- If an I/O error occurs
 
 
- 
 
-