java.io

クラス BufferedWriter

java.lang.Object

java.io.Writer

java.io.BufferedWriter

すべての実装されたインタフェース:

Closeable、Flushable、Appendable、AutoCloseable

public class BufferedWriter
extends Writer

文字をバッファリングすることによって、文字、配列、または文字列を効率良く文字型出力ストリームに書き込みます。

バッファーのサイズは、デフォルト値のままにすることも、特定の値を指定することもできます。デフォルト値は、通常の使い方では十分な大きさです。

システムプロパティーの line.separator で定義される行区切り文字はプラットフォームに依存するため、newLine() メソッドが提供されています。すべてのプラットフォームが改行文字 ('\n') で行を終端させるわけではありません。改行文字を直接書き込むよりも、このメソッドを呼び出して行を終了させることをお勧めします。

一般的に、Writer は、その出力をただちにベースとなる文字型ストリームまたはバイトストリームに送信します。プロンプト出力を必要とする場合以外では、FileWriter や OutputStreamWriter のような Writer から直接 write() オペレーションを呼び出すのは効率が悪いので、BufferedWriter でラップすることをお勧めします。次に例を示します。

 PrintWriter out
   = new PrintWriter(new BufferedWriter(new FileWriter("foo.out")));
 

この例は PrintWriter のファイルへの出力をバッファリングします。バッファリングしない場合は、print() メソッドを呼び出すたびに文字をバイトに変換してただちにファイルに書き込むので、効率が非常に悪くなります。

導入されたバージョン:

JDK1.1

関連項目:

PrintWriter、FileWriter、OutputStreamWriter、Files.newBufferedWriter(java.nio.file.Path, java.nio.charset.Charset, java.nio.file.OpenOption...)

フィールドのサマリー

クラス java.io.Writer から継承されたフィールド

lock

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
BufferedWriter(Writer out) デフォルトサイズの出力バッファーでバッファリングされた、文字型出力ストリームを作成します。
BufferedWriter(Writer out, int sz) 指定されたサイズの出力バッファーでバッファリングされた、文字型出力ストリームを新しく作成します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
void	close() ストリームを最初にフラッシュして、閉じます。
void	flush() ストリームをフラッシュします。
void	newLine() 改行文字を書き込みます。
void	write(char[] cbuf, int off, int len) 文字の配列の一部を書き込みます。
void	write(int c) 単一の文字を書き込みます。
void	write(String s, int off, int len) String の一部を書き込みます。

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

append, append, append, write, write

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

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

コンストラクタの詳細

BufferedWriter

public BufferedWriter(Writer out)

デフォルトサイズの出力バッファーでバッファリングされた、文字型出力ストリームを作成します。

パラメータ:

out - Writer

BufferedWriter

public BufferedWriter(Writer out,
              int sz)

指定されたサイズの出力バッファーでバッファリングされた、文字型出力ストリームを新しく作成します。

パラメータ:

out - Writer

sz - 出力バッファーのサイズ。正の整数

例外:

IllegalArgumentException - sz が 0 以下の場合

メソッドの詳細

write

public void write(int c)
           throws IOException

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

オーバーライド:

write、クラス: Writer

パラメータ:

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

例外:

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

write

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

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

通常このメソッドは、指定された配列からこのストリームのバッファーへ文字を格納し、必要に応じてベースとなるストリームにバッファーをフラッシュします。しかし、要求された長さがこのストリームのバッファーと同じ大きさ以上の場合、このメソッドはバッファーをフラッシュし、その文字を直接ベースとなるストリームに書き込みます。このため、余分な BufferedWriter がデータを不必要にコピーすることがありません。

定義:

write、クラス: Writer

パラメータ:

cbuf - 文字型配列

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

len - 書き込む文字数

例外:

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

write

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

String の一部を書き込みます。

len パラメータの値が負の場合は、文字が書き込まれません。これは、IndexOutOfBoundsException がスローされる必要があるスーパークラスでのこのメソッドの仕様と異なります。

オーバーライド:

write、クラス: Writer

パラメータ:

s - 書き込まれる文字列

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

len - 書き込む文字数

例外:

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

newLine

public void newLine()
             throws IOException

改行文字を書き込みます。改行文字は、システムの line.separator プロパティーにより定義され、必ずしも単一の改行文字 ('\n') であるとは限りません。

例外:

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

flush

public void flush()
           throws IOException

ストリームをフラッシュします。

定義:

flush、インタフェース: Flushable

定義:

flush、クラス: Writer

例外:

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

close

public void close()
           throws IOException

次のクラスからコピーされた説明: Writer

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

定義:

close、インタフェース: Closeable

定義:

close、インタフェース: AutoCloseable

定義:

close、クラス: Writer

例外:

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