JavaTM Platform
Standard Ed. 6

java.io
クラス StringWriter

java.lang.Object
  上位を拡張 java.io.Writer
      上位を拡張 java.io.StringWriter
すべての実装されたインタフェース:
Closeable, Flushable, Appendable

public class StringWriter
extends Writer

出力を文字列バッファーに集める文字ストリームです。この文字列バッファーを使って文字列を構築します。

StringWriter を閉じても、何の影響もありません。IOException を生成せずにストリームが閉じられたあとで、このクラスのメソッドを呼び出すことができます。

導入されたバージョン:
JDK1.1

フィールドの概要
 
クラス java.io.Writer から継承されたフィールド
lock
 
コンストラクタの概要
StringWriter()
          デフォルトの初期文字列バッファーサイズを使って、新しい文字列ライターを作成します。
StringWriter(int initialSize)
          指定された初期文字列バッファーサイズを使って、新しい文字列ライターを作成します。
 
メソッドの概要
 StringWriter append(char c)
          指定された文字をこのライターに追加します。
 StringWriter append(CharSequence csq)
          指定された文字シーケンスをこのライターに追加します。
 StringWriter append(CharSequence csq, int start, int end)
          指定された文字シーケンスのサブシーケンスをこのライターに追加します。
 void close()
          StringWriter を閉じても、何の影響もありません。
 void flush()
          ストリームをフラッシュします。
 StringBuffer getBuffer()
          文字列バッファーそのものを返します。
 String toString()
          バッファーの現在の値を文字列として返します。
 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.io.Writer から継承されたメソッド
write
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

コンストラクタの詳細

StringWriter

public StringWriter()
デフォルトの初期文字列バッファーサイズを使って、新しい文字列ライターを作成します。


StringWriter

public StringWriter(int initialSize)
指定された初期文字列バッファーサイズを使って、新しい文字列ライターを作成します。

パラメータ:
initialSize - このバッファーが自動的に拡張される前にこのバッファーに収まる char 値の数
例外:
IllegalArgumentException - initialSize が負の値の場合
メソッドの詳細

write

public void write(int c)
単一の文字を書き込みます。

オーバーライド:
クラス Writer 内の write
パラメータ:
c - 書き込む文字を指定する int

write

public void write(char[] cbuf,
                  int off,
                  int len)
文字の配列の一部を書き込みます。

定義:
クラス Writer 内の write
パラメータ:
cbuf - 文字の配列
off - 文字の書き込み開始オフセット
len - 書き込む文字数

write

public void write(String str)
文字列を書き込みます。

オーバーライド:
クラス Writer 内の write
パラメータ:
str - 書き込まれる文字列

write

public void write(String str,
                  int off,
                  int len)
文字列の一部を書き込みます。

オーバーライド:
クラス Writer 内の write
パラメータ:
str - 書き込まれる文字列
off - 文字の書き込み開始オフセット
len - 書き込む文字数

append

public StringWriter append(CharSequence csq)
指定された文字シーケンスをこのライターに追加します。  

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

     out.write(csq.toString()) 
 

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

定義:
インタフェース Appendable 内の append
オーバーライド:
クラス Writer 内の append
パラメータ:
csq - 追加される文字シーケンス。csqnull の場合は、このライターに「null」という 4 文字が追加される
戻り値:
このライター
導入されたバージョン:
1.5

append

public StringWriter append(CharSequence csq,
                           int start,
                           int end)
指定された文字シーケンスのサブシーケンスをこのライターに追加します。  

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

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

定義:
インタフェース Appendable 内の append
オーバーライド:
クラス Writer 内の append
パラメータ:
csq - サブシーケンスの追加元の文字シーケンス。csqnull であれば、csq に「null」という 4 文字が含まれているかのように追加される
start - サブシーケンスの最初の文字のインデックス
end - サブシーケンスの最後の文字のあとに続く文字のインデックス
戻り値:
このライター
例外:
IndexOutOfBoundsException - start または end が負の値の場合、startend より大きい場合、または endcsq.length() より大きい場合
導入されたバージョン:
1.5

append

public StringWriter append(char c)
指定された文字をこのライターに追加します。  

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

     out.write(c) 

定義:
インタフェース Appendable 内の append
オーバーライド:
クラス Writer 内の append
パラメータ:
c - 追加される 16 ビット文字
戻り値:
このライター
導入されたバージョン:
1.5

toString

public String toString()
バッファーの現在の値を文字列として返します。

オーバーライド:
クラス Object 内の toString
戻り値:
このオブジェクトの文字列表現

getBuffer

public StringBuffer getBuffer()
文字列バッファーそのものを返します。

戻り値:
現在のバッファー値を保持する StringBuffer

flush

public void flush()
ストリームをフラッシュします。

定義:
インタフェース Flushable 内の flush
定義:
クラス Writer 内の flush

close

public void close()
           throws IOException
StringWriter を閉じても、何の影響もありません。IOException を生成せずにストリームが閉じられたあとで、このクラスのメソッドを呼び出すことができます。

定義:
インタフェース Closeable 内の close
定義:
クラス Writer 内の close
例外:
IOException - 入出力エラーが発生した場合

JavaTM Platform
Standard Ed. 6

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2009 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。