JavaTM 2 Platform
Standard Ed. 5.0

java.io
クラス OutputStreamWriter

java.lang.Object
  上位を拡張 java.io.Writer
      上位を拡張 java.io.OutputStreamWriter
すべての実装されたインタフェース:
Closeable, Flushable, Appendable
直系の既知のサブクラス:
FileWriter

public class OutputStreamWriter
extends Writer

OutputStreamWriter は、文字ストリームからバイトストリームへの橋渡しの役目を持ちます。バイトストリームに書き込まれた文字は、指定された charset を使用してバイトに符号化されます。使用する文字セットは、名前で指定するか、明示的に渡すか、またはプラットフォームのデフォルトの文字セットをそのまま使うこともできます。

write() メソッドを呼び出すたびに、指定された文字に対してエンコーディングコンバータが呼び出されます。結果として生成されたバイトは、バッファに蓄積されてから基本となる出力ストリームに書き込まれます。このバッファのサイズは指定できますが、ほとんどの場合、デフォルトのサイズで十分です。write() メソッドに渡される文字はバッファに入らないので注意してください。

最大限に効率化するには、コンバータを頻繁に呼び出さないようにするために BufferedWriter の内部に OutputStreamWriter をラップするように考慮してください。次に例を示します。


 Writer out
   = new BufferedWriter(new OutputStreamWriter(System.out));
 

「サロゲートペア」は、2 つの char 値によって表される文字で、\uD800 〜 \uDBFF の「上位」サロゲートと \uDC00 〜 \uDFFF の「下位」サロゲートから構成されます。サロゲートペアによって表される文字が指定された文字セットによって変換できない場合は、文字セット依存の「代替シーケンス」が出力ストリームに書き込まれます。

対応する下位サロゲートがない上位サロゲート、または対応する上位サロゲートがない下位サロゲートは、「不正なサロゲート要素」と呼ばれます。不正なサロゲート要素を含む文字ストリームは書き込まないでください。不正なサロゲート要素を書き込んだ場合、このクラスのインスタンスの動作は保証されません。

導入されたバージョン:
JDK1.1
関連項目:
BufferedWriter, OutputStream, Charset

フィールドの概要
 
クラス java.io.Writer から継承されたフィールド
lock
 
コンストラクタの概要
OutputStreamWriter(OutputStream out)
          デフォルトの文字セットを使う OutputStreamWriter を作成します。
OutputStreamWriter(OutputStream out, Charset cs)
          与えられた文字セットを使う OutputStreamWriter を作成します。
OutputStreamWriter(OutputStream out, CharsetEncoder enc)
          与えられた文字セットエンコーダを使う OutputStreamWriter を作成します。
OutputStreamWriter(OutputStream out, String charsetName)
          指定された文字セットを使う OutputStreamWriter を作成します。
 
メソッドの概要
 void close()
          ストリームを閉じます。
 void flush()
          ストリームをフラッシュします。
 String getEncoding()
          このストリームで使用される文字セットの名前を返します。
 void write(char[] cbuf, int off, int len)
          文字の配列の一部を書き込みます。
 void write(int c)
          単一の文字を書き込みます。
 void write(String str, int off, int len)
          文字列の一部を書き込みます。
 
クラス java.io.Writer から継承されたメソッド
append, append, append, write, write
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

OutputStreamWriter

public OutputStreamWriter(OutputStream out,
                          String charsetName)
                   throws UnsupportedEncodingException
指定された文字セットを使う OutputStreamWriter を作成します。

パラメータ:
out - OutputStream
charsetName - サポートする charset の名前
例外:
UnsupportedEncodingException - 指定された文字セットがサポートされていない場合

OutputStreamWriter

public OutputStreamWriter(OutputStream out)
デフォルトの文字セットを使う OutputStreamWriter を作成します。

パラメータ:
out - OutputStream

OutputStreamWriter

public OutputStreamWriter(OutputStream out,
                          Charset cs)
与えられた文字セットを使う OutputStreamWriter を作成します。

パラメータ:
out - OutputStream
cs - charset
導入されたバージョン:
1.4

OutputStreamWriter

public OutputStreamWriter(OutputStream out,
                          CharsetEncoder enc)
与えられた文字セットエンコーダを使う OutputStreamWriter を作成します。

パラメータ:
out - OutputStream
enc - 文字セットエンコーダ
導入されたバージョン:
1.4
メソッドの詳細

getEncoding

public String getEncoding()
このストリームで使用される文字セットの名前を返します。

エンコーディングに互換名がある場合は、その名前を返します。互換名がない場合は、エンコーディングの標準名を返します。

このインスタンスが OutputStreamWriter(OutputStream, String) コンストラクタを使用して作成されている場合、そのコンストラクタに渡された名前ではなく、エンコーディングの一意名が返されます。このメソッドは、ストリームが閉じている場合、null を返すことがあります。

戻り値:
このエンコーディングの互換名。ストリームが閉じている場合は null
関連項目:
Charset

write

public void write(int c)
           throws IOException
単一の文字を書き込みます。

オーバーライド:
クラス Writer 内の write
パラメータ:
c - 書き込む文字を指定する int
例外:
IOException - 入出力エラーが発生した場合

write

public void write(char[] cbuf,
                  int off,
                  int len)
           throws IOException
文字の配列の一部を書き込みます。

定義:
クラス Writer 内の write
パラメータ:
cbuf - 文字のバッファ
off - 文字の書き込み開始オフセット
len - 書き込む文字数
例外:
IOException - 入出力エラーが発生した場合

write

public void write(String str,
                  int off,
                  int len)
           throws IOException
文字列の一部を書き込みます。

オーバーライド:
クラス Writer 内の write
パラメータ:
str - 文字列
off - 文字の書き込み開始オフセット
len - 書き込む文字数
例外:
IOException - 入出力エラーが発生した場合

flush

public void flush()
           throws IOException
ストリームをフラッシュします。

定義:
インタフェース Flushable 内の flush
定義:
クラス Writer 内の flush
例外:
IOException - 入出力エラーが発生した場合

close

public void close()
           throws IOException
ストリームを閉じます。

定義:
インタフェース Closeable 内の close
定義:
クラス Writer 内の close
例外:
IOException - 入出力エラーが発生した場合

JavaTM 2 Platform
Standard Ed. 5.0

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java 2 SDK SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。