This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.io
class OutputStreamWriter

java.lang.Object extended by java.io.Writer extended by java.io.OutputStreamWriter
All Implemented Interfaces:
Closeable, Flushable, Appendable
Direct Known Subclasses:
FileWriter

Most common ways to construct:

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.

See Also (auto-generated):

Writer

BufferedReader

BufferedWriter


Field Summary
 
Fields inherited from class java.io.Writer
lock
 
Constructor Summary

          Creates an OutputStreamWriter that uses the default character encoding.

          Creates an OutputStreamWriter that uses the given charset.

          Creates an OutputStreamWriter that uses the given charset encoder.

          Creates an OutputStreamWriter that uses the named charset.
 
Method Summary
 void

          Closes the stream, flushing it first.
 void

          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
write(String str, int off, int len)

          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

OutputStreamWriter

public OutputStreamWriter(OutputStream out)
Creates an OutputStreamWriter that uses the default character encoding.

Parameters:
out - An OutputStream

OutputStreamWriter

public OutputStreamWriter(OutputStream out,
                          Charset cs)
Creates an OutputStreamWriter that uses the given charset.

Parameters:
out - An OutputStream
cs - A charset

OutputStreamWriter

public OutputStreamWriter(OutputStream out,
                          CharsetEncoder enc)
Creates an OutputStreamWriter that uses the given charset encoder.

Parameters:
out - An OutputStream
enc - A charset encoder

OutputStreamWriter

public 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 {@link java.nio.charset.Charset charset}
Throws:
UnsupportedEncodingException - If the named encoding is not supported
Method Detail

close

public void close()
           throws IOException
Overrides:
close in class Writer
Throws:
IOException

flush

public void flush()
           throws IOException
Flushes the stream.

Overrides:
flush in class Writer
Throws:
IOException - If an I/O error occurs

getEncoding

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 {@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.

Returns:
The historical name of this encoding, or possibly null if the stream has been closed

write

public void write(char[] cbuf,
                  int off,
                  int len)
           throws IOException
Writes a portion of an array of characters.

Overrides:
write in class Writer
Parameters:
cbuf - Buffer of characters
off - Offset from which to start writing characters
len - Number of characters to write
Throws:
IOException - If an I/O error occurs

write

public void write(int c)
           throws IOException
Writes a single character.

Overrides:
write in class Writer
Parameters:
c
Throws:
IOException - If an I/O error occurs

write

public void write(String str,
                  int off,
                  int len)
           throws IOException
Writes a portion of a string.

Overrides:
write in class Writer
Parameters:
str - A String
off - Offset from which to start writing characters
len - Number of characters to write
Throws:
IOException - If an I/O error occurs


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.