モジュール java.base
パッケージ java.io

クラスStringWriter

  • すべての実装されたインタフェース:
    Closeable, Flushable, Appendable, AutoCloseable

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

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

    導入されたバージョン:
    1.1
    • フィールドのサマリー

      • クラス java.io.Writerで宣言されたフィールド

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

      コンストラクタ 
      コンストラクタ 説明
      StringWriter()
      デフォルトの初期文字列バッファ・サイズを使って、新しい文字列ライターを作成します。
      StringWriter​(int initialSize)
      指定された初期文字列バッファ・サイズを使って、新しい文字列ライターを作成します。
    • コンストラクタの詳細

      • StringWriter

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

        public StringWriter​(int initialSize)
        指定された初期文字列バッファ・サイズを使って、新しい文字列ライターを作成します。
        パラメータ:
        initialSize - このバッファが自動的に拡張される前にこのバッファに収まるchar値の数
        例外:
        IllegalArgumentException - initialSizeが負の値の場合
    • メソッドの詳細

      • write

        public void write​(int c)
        単一の文字を書き込みます。
        オーバーライド:
        write、クラス: Writer
        パラメータ:
        c - 書き込まれる文字を指定するint
      • write

        public void write​(char[] cbuf,
                          int off,
                          int len)
        文字の配列の一部を書き込みます。
        定義:
        write、クラス: Writer
        パラメータ:
        cbuf - 文字の配列
        off - 文字の書込み開始オフセット
        len - 書き込む文字数
        例外:
        IndexOutOfBoundsException - offが負の場合、またはlenが負の場合、またはoff + lenが負の場合、または指定された配列の長さより大きい場合
      • write

        public void write​(String str)
        文字列を書き込みます。
        オーバーライド:
        write、クラス: Writer
        パラメータ:
        str - 書き込まれる文字列
      • write

        public void write​(String str,
                          int off,
                          int len)
        文字列の一部を書き込みます。
        オーバーライド:
        write、クラス: Writer
        パラメータ:
        str - 書き込まれる文字列
        off - 文字の書込み開始オフセット
        len - 書き込む文字数
        例外:
        IndexOutOfBoundsException - offが負の場合、lenが負の場合、またはoff + lenが負であるか、指定された文字列の長さよりも大きい場合
      • append

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

        このメソッドをout.append(csq)の形式で呼び出した場合、次の呼び出しとまったく同様に動作します。

             out.write(csq.toString()) 

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

        定義:
        append、インタフェース: Appendable
        オーバーライド:
        append、クラス: Writer
        パラメータ:
        csq - 追加するcharシーケンス。 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())
         

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

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

        このメソッドをout.append(c)の形式で呼び出した場合、次の呼び出しとまったく同様に動作します。

             out.write(c) 

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

        public String toString()
        バッファの現在の値を文字列として返します。
        オーバーライド:
        toString 、クラス:  Object
        戻り値:
        このオブジェクトの文字列表現
      • getBuffer

        public StringBuffer getBuffer()
        文字列バッファそのものを返します。
        戻り値:
        現在のバッファ値を保持するStringBuffer。
      • flush

        public void flush()
        ストリームをフラッシュします。
        定義:
        flush、インタフェース: Flushable
        定義:
        flush、クラス: Writer
      • close

        public void close()
                   throws IOException
        StringWriterを閉じても、何の影響もありません。 IOExceptionを生成せずにストリームが閉じられたあとで、このクラスのメソッドを呼び出すことができます。
        定義:
        close、インタフェース: AutoCloseable
        定義:
        close、インタフェース: Closeable
        定義:
        close、クラス: Writer
        例外:
        IOException - 入出力エラーが発生した場合