java.io: public class: OutputStreamWriter

java.io
public class: OutputStreamWriter [javadoc | source]

java.lang.Object
   java.io.Writer
      java.io.OutputStreamWriter

All Implemented Interfaces:
Flushable, Closeable, Appendable

Direct Known Subclasses:
FileWriter

An OutputStreamWriter is a bridge from character streams to byte streams: Characters written to it are encoded into bytes using a specified 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.

Also see:

BufferedWriter

OutputStream

java.nio.charset.Charset

author: Mark - Reinhold

since: JDK1.1 -

Fields inherited from java.io.Writer:
lock

Constructor:

Constructor:
public OutputStreamWriter(OutputStream out) { super(out); try { se = StreamEncoder.forOutputStreamWriter(out, this, (String)null); } catch (UnsupportedEncodingException e) { throw new Error(e); } } Creates an OutputStreamWriter that uses the default character encoding. Parameters: `out` - An OutputStream
public OutputStreamWriter(OutputStream out, String charsetName) throws UnsupportedEncodingException { super(out); if (charsetName == null) throw new NullPointerException("charsetName"); se = StreamEncoder.forOutputStreamWriter(out, this, charsetName); } 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 exception: UnsupportedEncodingException - If the named encoding is not supported`
public OutputStreamWriter(OutputStream out, Charset cs) { super(out); if (cs == null) throw new NullPointerException("charset"); se = StreamEncoder.forOutputStreamWriter(out, this, cs); } Creates an OutputStreamWriter that uses the given charset. Parameters: `out` - An OutputStream `cs` - A charset since: `1.4` - spec: `JSR-51` -
public OutputStreamWriter(OutputStream out, CharsetEncoder enc) { super(out); if (enc == null) throw new NullPointerException("charset encoder"); se = StreamEncoder.forOutputStreamWriter(out, this, enc); } Creates an OutputStreamWriter that uses the given charset encoder. Parameters: `out` - An OutputStream `enc` - A charset encoder since: `1.4` - spec: `JSR-51` -

 public OutputStreamWriter(OutputStream out) {
        super(out);
        try {
            se = StreamEncoder.forOutputStreamWriter(out, this, (String)null);
        } catch (UnsupportedEncodingException e) {
            throw new Error(e);
        }
}

Creates an OutputStreamWriter that uses the default character encoding.

Parameters:

out - An OutputStream

 public OutputStreamWriter(OutputStream out,
    String charsetName) throws UnsupportedEncodingException {
        super(out);
        if (charsetName == null)
            throw new NullPointerException("charsetName");
        se = StreamEncoder.forOutputStreamWriter(out, this, charsetName);
}

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
exception: UnsupportedEncodingException - 
            If the named encoding is not supported

 public OutputStreamWriter(OutputStream out,
    Charset cs) {
        super(out);
        if (cs == null)
            throw new NullPointerException("charset");
        se = StreamEncoder.forOutputStreamWriter(out, this, cs);
}

Parameters:

out - An OutputStream

cs - A charset

since: 1.4 -

spec: JSR-51 -

 public OutputStreamWriter(OutputStream out,
    CharsetEncoder enc) {
        super(out);
        if (enc == null)
            throw new NullPointerException("charset encoder");
        se = StreamEncoder.forOutputStreamWriter(out, this, enc);
}

Parameters:

out - An OutputStream

enc - A charset encoder

since: 1.4 -

spec: JSR-51 -

Method from java.io.OutputStreamWriter Summary:
close, flush, flushBuffer, getEncoding, write, write, write

Methods from java.io.Writer:
append, append, append, close, flush, write, write, write, write, write

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from java.io.OutputStreamWriter Detail:
public void close() throws IOException { se.close(); }
public void flush() throws IOException { se.flush(); } Flushes the stream.
void flushBuffer() throws IOException { se.flushBuffer(); } 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.
public String getEncoding() { return se.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 return `null` if the stream has been closed.
public void write(int c) throws IOException { se.write(c); } Writes a single character.
public void write(char[] cbuf, int off, int len) throws IOException { se.write(cbuf, off, len); } Writes a portion of an array of characters.
public void write(String str, int off, int len) throws IOException { se.write(str, off, len); } Writes a portion of a string.

Method from java.io.OutputStreamWriter Detail:

 public  void close() throws IOException {
        se.close();
}

 public  void flush() throws IOException {
        se.flush();
}

Flushes the stream.

  void flushBuffer() throws IOException {
        se.flushBuffer();
}

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.

 public String getEncoding() {
        return se.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 #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.

 public  void write(int c) throws IOException {
        se.write(c);
}

Writes a single character.

 public  void write(char[] cbuf,
    int off,
    int len) throws IOException {
        se.write(cbuf, off, len);
}

Writes a portion of an array of characters.

 public  void write(String str,
    int off,
    int len) throws IOException {
        se.write(str, off, len);
}

Writes a portion of a string.