Class java.io.OutputStreamWriter - JDK 5 Documentation v1.1.8, Java 2 SDK 英文文档

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.io.OutputStreamWriter

java.lang.Object
   |
   +----java.io.Writer
           |
           +----java.io.OutputStreamWriter

public class OutputStreamWriter
extends Writer

Write characters to an output stream, translating characters into bytes according to a specified character encoding. Each OutputStreamWriter incorporates its own CharToByteConverter, and is thus a bridge from character streams to byte streams.

The encoding used by an OutputStreamWriter may be specified by name, by providing a CharToByteConverter, or by accepting the default encoding, which is defined by the system property file.encoding.

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));

See Also:: BufferedWriter, OutputStream

OutputStreamWriter(OutputStream): Create an OutputStreamWriter that uses the default character encoding.
OutputStreamWriter(OutputStream, String): Create an OutputStreamWriter that uses the named character encoding.

close(): Close the stream.
flush(): Flush the stream.
getEncoding(): Return the name of the encoding being used by this stream.
write(char[], int, int): Write a portion of an array of characters.
write(int): Write a single character.
write(String, int, int): Write a portion of a string.

OutputStreamWriter

 public OutputStreamWriter(OutputStream out,
                           String enc) throws UnsupportedEncodingException

Create an OutputStreamWriter that uses the named character encoding.

Parameters:: out - An OutputStream; enc - Name of the encoding to be used
Throws: UnsupportedEncodingException: If the named encoding is not supported

OutputStreamWriter

 public OutputStreamWriter(OutputStream out)

Create an OutputStreamWriter that uses the default character encoding.

Parameters:: out - An OutputStream

getEncoding

 public String getEncoding()

Return the name of the encoding being used by this stream. May return null if the stream has been closed.

write

 public void write(int c) throws IOException

Write a single character.

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

write

 public void write(char cbuf[],
                   int off,
                   int len) throws IOException

Write a portion of an array of characters.

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
Overrides:: write in class Writer

write

 public void write(String str,
                   int off,
                   int len) throws IOException

Write a portion of a string.

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
Overrides:: write in class Writer

flush

 public void flush() throws IOException

Flush the stream.

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

close

 public void close() throws IOException

Close the stream.

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

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Submit a bug or feature - Version 1.1.8 of Java Platform API Specification
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1995-1999 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.