java.io
クラス Writer

java.lang.Object
  java.io.Writer

直系の既知のサブクラス:

OutputStreamWriter

public abstract class Writer
extends Object

文字をストリーム出力するための機能の枠組みを持った抽象クラスです。 サブクラスでは最低限 write(char[], int, int) メソッドと flush() メソッドおよび close() メソッドを実装する必要があります。

関連項目:

Reader

lock

protected Object lock

このクラスがストリーム処理を行う際に同期を取るために使用するオブジェクトを保持しています。 ストリーム処理で同期が必要な処理を行う場合にはこのオブジェクトに対して同期の要求を行います。 このクラスのサブクラスでも同期が必要な場合はこのオブジェクトに対して同期の要求を出すように記述しなければなりません。

     synchronized(lock) {
         // ロックが必要な処理をここに記述する。
     }

Writer

protected Writer()

自分自身をロック対象のオブジェクトに設定したオブジェクトを生成します。

Writer

protected Writer(Object lock)

渡されたオブジェクトを同期要求に使用するように設定したオブジェクトを生成します。

パラメータ:

lock - 同期に使用するオブジェクトを渡します。

write

public void write(int data)
           throws IOException

ストリームへ文字を 1 つ書き込みます。 書き込む文字は int 型で指定しますが、実際に書き込まれるのは下位 16 ビットのみです。 残りの上位 16 ビットは処理に影響しません。

このメソッドは文字の書き込みが完了するか例外が throw されるまでブロックします。

サブクラスが最適化された１文字読み出し処理をサポートできる場合はこのメソッドをオーバーライドして実装すべきです。

パラメータ:

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

例外:

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

write

public void write(char[] data)
           throws IOException

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

このメソッドで例外が throw されるのは以下の場合です。

• 何らかの理由で書き込みに失敗した場合は IOException を throw します。
• data が null 場合は NullPointerException が throw されます。

これらの例外が throw された場合でも、そこまでに書き込んだ文字は取り消されません。

Writer クラスにおけるこのメソッドは、write(data, 0, data.length) と記述するのと等価です。

パラメータ:

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

例外:

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

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

write

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

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

このメソッドで例外が throw されるのは以下の場合です。

• 何らかの理由で書き込みに失敗した場合は IOException を throw します。
• index が負数あるいは index + length が data のサイズを超える場合は IndexOutOfBoundsException が throw されます。
• data が null 場合は NullPointerException が throw されます。

これらの例外が throw された場合でも、そこまでに書き込んだ文字は取り消されません。

サブクラスでは必ずこのメソッドをオーバーライドして処理を記述しなければなりません。

パラメータ:

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

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

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

例外:

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

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

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

write

public void write(String data)
           throws IOException

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

このメソッドで例外が throw されるのは以下の場合です。

• 何らかの理由で書き込みに失敗した場合は IOException を throw します。
• data が null 場合は NullPointerException が throw されます。

これらの例外が throw された場合でも、そこまでに書き込んだ文字は取り消されません。

パラメータ:

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

例外:

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

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

write

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

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

このメソッドで例外が throw されるのは以下の場合です。

• 何らかの理由で書き込みに失敗した場合は IOException を throw します。
• index が負数あるいは index + length が String オブジェクトが保持する文字列のサイズを超える場合は IndexOutOfBoundsException が throw されます。
• data が null 場合は NullPointerException が throw されます。

これらの例外が throw された場合でも、そこまでに書き込んだ文字は取り消されません。

パラメータ:

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

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

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

例外:

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

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

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

flush

public abstract void flush()
                    throws IOException

ストリームがバッファリングを行っている場合、そのバッファに格納されている文字を直ちに書き込み先に出力します。 また同時に書き込み先もフラッシュします。 サブクラスでバッファリングを伴う実装を行う場合はこのメソッドを適切に実装しなければなりません。

例外:

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

close

public abstract void close()
                    throws IOException

ストリームをクローズし、関連するリソースをすべて開放します。 以後、該当するオブジェクトによるストリーム処理は一切行えません。

例外:

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