java.io
クラス OutputStreamWriter

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

public class OutputStreamWriter
extends Writer

バイトによる出力を行う OutputStream クラスと文字による出力を行う Writer クラスの仲立的な処理を持ったクラスです。 出力ストリームと必要に応じて文字エンコーディング名を渡すと、渡した出力ストリームへ Writer クラスの規約に従った書き込みを行えます。 この際の文字エンコーディングは、文字エンコーディングを指定しなかった場合はプラットフォームに依存したデフォルトの文字エンコーディングを使用します。 文字エンコーディングを指定した場合はその文字エンコーディングを使用します。

このクラスと逆に InputStream クラスと文字による入力を行う Reader クラスの仲立ち的な処理を行う InputStreamReader クラスが用意されています。

導入されたバージョン:

CLDC 1.0

関連項目:

OutputStream, InputStreamReader, System.getProperty(java.lang.String)

OutputStreamWriter

public OutputStreamWriter(OutputStream os)

出力ストリームを受け取ってオブジェクトを構築します。 文字エンコーディングがプラットフォームのデフォルトを使用します。

パラメータ:

os - 処理を行う対象の出力ストリームを渡します。

関連項目:

System.getProperty(String)

OutputStreamWriter

public OutputStreamWriter(OutputStream os,
                          String encoding)
                   throws UnsupportedEncodingException

出力ストリームと文字エンコーディング名を受け取ってオブジェクトを構築します。 指定された文字エンコーディングをサポートしていない場合は UnsupportedEncodingException を throw します。

パラメータ:

os - 処理を行う対象の出力ストリームを渡します。

encoding - 使用する文字エンコーディング名を渡します。

例外:

UnsupportedEncodingException - 指定された文字エンコーディング名をサポートしていない場合に throw します。

write

public void write(int data)
           throws IOException

ストリームへ文字を 1 つ書き込みます。 このメソッドは文字の書き込みが完了するか例外が throw されるまでブロックします。

オーバーライド:

クラス Writer 内の write

パラメータ:

data - 書き込む文字を渡します。

例外:

IOException - 文字の書き込み時に何らかの障害が発生した場合に throw します。

write

public void write(char[] data,
                  int index,
                  int length)
           throws IOException

ストリームへ指定された文字数の文字を指定された char 配列の指定位置から書き込みます。 このメソッドは指定文字数の書き込みが完了するか、例外が throw されるまでブロックします。

定義:

クラス Writer 内の write

パラメータ:

data - 書き込む文字列を格納した char 配列を渡します。

index - 書き込む文字列を格納した char 配列の書き込み開始位置を渡します。

length - 書き込む文字数を渡します。

例外:

IOException - 文字の書き込み時に何らかの障害が発生した場合に throw します。

NullPointerException - data に null が渡された場合に throw します。

IndexOutOfBoundsException - index が負数あるいは index + length が data のサイズを超える場合に throw します。

write

public void write(String data,
                  int index,
                  int length)
           throws IOException

ストリームへ渡された String オブジェクトが保持している文字列の一部を書き込みます。 書き込まれる文字列は渡された String オブジェクトが保持する文字列の index 以降の length 文字となります。 このメソッドは文字列の書き込みが完了するか、例外が throw されるまでブロックします。

オーバーライド:

クラス Writer 内の write

パラメータ:

data - 書き込む対象の文字列を持った String オブジェクトを渡します。

index - 書き込む対象の文字列の書き込み開始位置を渡します。

length - 書き込む文字列の長さを渡します。

例外:

IOException - 文字の書き込み時に何らかの障害が発生した場合に throw します。

NullPointerException - data に null が渡された場合に throw します。

IndexOutOfBoundsException - index が負数あるいは index + length が String オブジェクトが保持する文字列のサイズを超える場合に throw します。

flush

public void flush()
           throws IOException

ストリームがバッファリングを行っている場合、そのバッファに格納されている文字を直ちに書き込み先に出力します。 また同時に出力ストリームもフラッシュします。

定義:

クラス Writer 内の flush

例外:

IOException - 処理に伴い、出力関係で何らかの障害が発生した場合に throw します。

close

public void close()
           throws IOException

ストリームをクローズし、関連するリソースをすべて開放します。

定義:

クラス Writer 内の close

例外:

IOException - 処理に伴い、出力関係で何らかの障害が発生した場合に throw します。