java.io
クラス CharArrayWriter

java.lang.Object
  java.io.Writer
      java.io.CharArrayWriter

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

Closeable, Flushable, Appendable

public class CharArrayWriter
extends Writer

Writer として使用する文字バッファーを実装します。ストリームに文字が書き込まれるに従って、バッファーは自動的に大きくなります。toCharArray() や toString() を使ってデータを取り出すことができます。

注:このクラスで close() を呼び出しても、何も変化はありません。ストリームを閉じたあとにこのクラスのメソッドを呼び出しても、IOException は生成されません。

導入されたバージョン:

JDK1.1

フィールドの概要

protected char[]	buf データが格納されるバッファーです。
protected int	count バッファーの中の文字数です。

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

lock

コンストラクタの概要

CharArrayWriter()
CharArrayWriter を新しく作成します。

CharArrayWriter(int initialSize)
指定された初期サイズで CharArrayWriter を新しく作成します。

メソッドの概要

CharArrayWriter	append(char c) 指定された文字をこのライターに追加します。
CharArrayWriter	append(CharSequence csq) 指定された文字シーケンスをこのライターに追加します。
CharArrayWriter	append(CharSequence csq, int start, int end) 指定された文字シーケンスのサブシーケンスをこのライターに追加します。
void	close() ストリームを閉じます。
void	flush() ストリームをフラッシュします。
void	reset() メモリー割り当て済みのバッファーを廃棄せずに再使用できるように、バッファーをリセットします。
int	size() バッファーの現在のサイズを返します。
char[]	toCharArray() 入力データのコピーを返します。
String	toString() 入力データを文字列に変換します。
void	write(char[] c, int off, int len) バッファーに文字を書き込みます。
void	write(int c) バッファーに単一の文字を書き込みます。
void	write(String str, int off, int len) 文字列の一部をバッファーに書き込みます。
void	writeTo(Writer out) バッファーの内容を別の文字ストリームに書き込みます。

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

write, write

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

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

フィールドの詳細

buf

protected char[] buf

データが格納されるバッファーです。

count

protected int count

バッファーの中の文字数です。

コンストラクタの詳細

CharArrayWriter

public CharArrayWriter()

CharArrayWriter を新しく作成します。

CharArrayWriter

public CharArrayWriter(int initialSize)

指定された初期サイズで CharArrayWriter を新しく作成します。

パラメータ:

initialSize - バッファーの初期サイズを指定する int

例外:

IllegalArgumentException - initialSize が負の値の場合

メソッドの詳細

write

public void write(int c)

バッファーに単一の文字を書き込みます。

オーバーライド:

クラス Writer 内の write

パラメータ:

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

write

public void write(char[] c,
                  int off,
                  int len)

バッファーに文字を書き込みます。

定義:

クラス Writer 内の write

パラメータ:

c - 書き込まれるデータ

off - データの開始オフセット

len - 書き込む文字数

write

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

文字列の一部をバッファーに書き込みます。

オーバーライド:

クラス Writer 内の write

パラメータ:

str - 書き込まれる文字列

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

len - 書き込む文字数

writeTo

public void writeTo(Writer out)
             throws IOException

バッファーの内容を別の文字ストリームに書き込みます。

パラメータ:

out - 書き込み先の出力ストリーム

例外:

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

append

public CharArrayWriter append(CharSequence csq)

指定された文字シーケンスをこのライターに追加します。

このメソッドを out.append(csq) の形式で呼び出した場合、次の呼び出しと同じ結果が得られます。

     out.write(csq.toString()) 

文字シーケンス csq に対する toString の指定に応じて、シーケンス全体が追加されないこともあります。たとえば、文字バッファーの toString メソッドを呼び出した場合、そのバッファーの位置とリミットによって決まる内容を持つサブシーケンスが返されます。

定義:

インタフェース Appendable 内の append

オーバーライド:

クラス Writer 内の append

パラメータ:

csq - 追加される文字シーケンス。csq が null の場合は、このライターに「null」という 4 文字が追加される

戻り値:

このライター

導入されたバージョン:

1.5

append

public CharArrayWriter append(CharSequence csq,
                              int start,
                              int end)

指定された文字シーケンスのサブシーケンスをこのライターに追加します。

csq が null ではないときに、このメソッドを out.append(csq, start, end) の形式で呼び出した場合、次の呼び出しと同じ結果が得られます。

     out.write(csq.subSequence(start, end).toString()) 

定義:

インタフェース Appendable 内の append

オーバーライド:

クラス Writer 内の append

パラメータ:

csq - サブシーケンスの追加元の文字シーケンス。csq が null であれば、csq に「null」という 4 文字が含まれているかのように追加される

start - サブシーケンスの最初の文字のインデックス

end - サブシーケンスの最後の文字のあとに続く文字のインデックス

戻り値:

このライター

例外:

IndexOutOfBoundsException - start または end が負の値の場合、start が end より大きい場合、または end が csq.length() より大きい場合

導入されたバージョン:

1.5

append

public CharArrayWriter append(char c)

指定された文字をこのライターに追加します。

このメソッドを out.append(c) の形式で呼び出した場合、次の呼び出しと同じ結果が得られます。

     out.write(c) 

定義:

インタフェース Appendable 内の append

オーバーライド:

クラス Writer 内の append

パラメータ:

c - 追加される 16 ビット文字

戻り値:

このライター

導入されたバージョン:

1.5

reset

public void reset()

メモリー割り当て済みのバッファーを廃棄せずに再使用できるように、バッファーをリセットします。

toCharArray

public char[] toCharArray()

入力データのコピーを返します。

戻り値:

この入力データからコピーされた文字の配列

size

public int size()

バッファーの現在のサイズを返します。

戻り値:

バッファーの現在のサイズを表す int

toString

public String toString()

入力データを文字列に変換します。

オーバーライド:

クラス Object 内の toString

戻り値:

文字列

flush

public void flush()

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

定義:

インタフェース Flushable 内の flush

定義:

クラス Writer 内の flush

close

public void close()

ストリームを閉じます。このメソッドの内容は以降も要求されるので、バッファーは解放されません。注:このクラスのこのメソッドを呼び出しても、何の効果もありません。

定義:

インタフェース Closeable 内の close

定義:

クラス Writer 内の close