java.io
クラス Writer

java.lang.Object
  java.io.Writer

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

BufferedWriter, CharArrayWriter, FilterWriter, OutputStreamWriter, PipedWriter, PrintWriter, StringWriter

public abstract class Writer
extends Object

文字ストリームに書き込むための abstract クラスです。サブクラスでの実装が必要なメソッドは、write(char[], int, int)、flush()、および close() だけです。ただし、ほとんどのサブクラスは、効率性の向上または機能の追加、あるいはその両方のために、ここで定義されるメソッドの一部をオーバーライドします。

導入されたバージョン:

JDK1.1

関連項目:

Writer, BufferedWriter, CharArrayWriter, FilterWriter, OutputStreamWriter, FileWriter, PipedWriter, PrintWriter, Reader

フィールドの概要

protected Object

lock このストリームに対する処理の同期に使用するオブジェクトです。

コンストラクタの概要

protected	Writer() そのクリティカルセクションがライター自体で同期する、新しい文字ストリームライターを作成します。
protected	Writer(Object lock) そのクリティカルセクションが指定されたオブジェクトで同期する、新しい文字ストリームライターを作成します。

メソッドの概要

abstract void	close() ストリームをフラッシュしてから閉じます。
abstract void	flush() ストリームをフラッシュします。
void	write(char[] cbuf) 文字の配列を書き込みます。
abstract void	write(char[] cbuf, int off, int len) 文字の配列の一部を書き込みます。
void	write(int c) 単一の文字を書き込みます。
void	write(String str) 文字列を書き込みます。
void	write(String str, int off, int len) 文字列の一部を書き込みます。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

lock

protected Object lock

このストリームに対する処理の同期に使用するオブジェクトです。効率を良くするため、文字ストリームオブジェクトは、ほかのオブジェクトを使ってクリティカルセクションを保護することができます。そのため、サブクラスでは this ではなくこのフィールドのオブジェクトを使用するか、同期化したメソッドを使用するようにしてください。

コンストラクタの詳細

Writer

protected Writer()

そのクリティカルセクションがライター自体で同期する、新しい文字ストリームライターを作成します。

Writer

protected Writer(Object lock)

そのクリティカルセクションが指定されたオブジェクトで同期する、新しい文字ストリームライターを作成します。

パラメータ:

lock - 同期するオブジェクト

メソッドの詳細

write

public void write(int c)
           throws IOException

単一の文字を書き込みます。書き込まれる文字は、指定された整数値の下位 16 ビットに格納されます。上位 16 ビットは無視されます。

有効な単一文字の出力をサポートするためのサブクラスでは、このメソッドをオーバーライドします。

パラメータ:

c - 書き込む文字を指定する int

例外:

IOException - 入出力エラーが発生した場合

write

public void write(char[] cbuf)
           throws IOException

文字の配列を書き込みます。

パラメータ:

cbuf - 書き込む文字の配列

例外:

IOException - 入出力エラーが発生した場合

write

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

文字の配列の一部を書き込みます。

パラメータ:

cbuf - 文字の配列

off - 文字の書き込み開始オフセット

len - 書き込む文字数

例外:

IOException - 入出力エラーが発生した場合

write

public void write(String str)
           throws IOException

文字列を書き込みます。

パラメータ:

str - 書き込まれる文字列

例外:

IOException - 入出力エラーが発生した場合

write

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

文字列の一部を書き込みます。

パラメータ:

str - 文字列

off - 文字の書き込み開始オフセット

len - 書き込む文字数

例外:

IOException - 入出力エラーが発生した場合

flush

public abstract void flush()
                    throws IOException

ストリームをフラッシュします。ストリームが各種の write() メソッドにより書き込まれた文字をバッファーに保存してある場合は、これらの文字の目的の転送先にただちに文字を書き込みます。さらに、転送先が別の文字ストリームまたはバイトストリームの場合は、この送信先をフラッシュします。つまり、1 つの flush() の呼び出しで、関連する Writer および OutputStream のすべてのバッファーをフラッシュします。

例外:

IOException - 入出力エラーが発生した場合

close

public abstract void close()
                    throws IOException

ストリームをフラッシュしてから閉じます。ストリームが閉じたあとに write() または flush() を呼び出すと、IOException がスローされます。ただし、すでに閉じているストリームを閉じても、何の影響もありません。

例外:

IOException - 入出力エラーが発生した場合