java.lang
クラス StringBuilder

java.lang.Object
  java.lang.StringBuilder

public final class StringBuilder
extends Object

StringBuilder は変更可能な文字列を保持するクラスです。

StringBuffer とは異なり、StringBuilder はスレッドセーフではありません。

コンストラクタの概要

StringBuilder()
16文字の容量を持つバッファの、空の文字列を保持する StringBuilder を生成します。

StringBuilder(int capacity)
指定された文字数の容量を持つバッファの、空の文字列を保持する StringBuilder を生成します。

StringBuilder(String s)
指定された文字列を保持する StringBuilder を生成します。

メソッドの概要

StringBuilder	append(boolean b) 指定された boolean 値の文字列表現をこのオブジェクトの文字列に付加して、このオブジェクト自身を返します。
StringBuilder	append(char c) 指定された文字をこのオブジェクトの文字列の後に連結して、このオブジェクト自身を返します。
StringBuilder	append(char[] ca) 指定された char 配列の文字列をこのオブジェクトの文字列の後に連結して、このオブジェクト自身を返します。
StringBuilder	append(char[] ca, int index, int len) 指定された char 配列の部分文字列をこのオブジェクトの文字列の後に連結して、このオブジェクト自身を返します。
StringBuilder	append(int i) 指定された int 値の文字列表現をこのオブジェクトの文字列に付加して、このオブジェクト自身を返します。
StringBuilder	append(long lv) 指定された long 値の文字列表現をこのオブジェクトの文字列に付加して、このオブジェクト自身を返します。
StringBuilder	append(Object o) 指定された Object の文字列表現をこのオブジェクトの文字列に付加して、このオブジェクト自身を返します。
StringBuilder	append(String str) 指定された String の文字列をこのオブジェクトの文字列の後に連結して、このオブジェクト自身を返します。
int	capacity() 現在のバッファサイズを返します。
char	charAt(int index) 指定されたインデックスにある文字を返します。
StringBuilder	delete(int start, int end) このオブジェクト中の、指定された範囲の部分文字列を削除して、このオブジェクト自身を返します。
StringBuilder	deleteCharAt(int index) 指定されたインデックスの文字を削除して、このオブジェクト自身を返します。
void	ensureCapacity(int minCapacity) 最低限指定されたサイズのバッファ容量を確保します。
void	getChars(int st, int ed, char[] dst, int dstst) 指定された範囲にある文字列を、指定された配列の指定された位置にコピーします。
int	indexOf(String string) 指定された文字列がこのオブジェクトの文字列中に最初に出現する位置を返します。
int	indexOf(String string, int fromIndex) 指定された文字列がこのオブジェクトの文字列中に最初に出現する位置を返します。
StringBuilder	insert(int index, boolean b) 指定された boolean 値の文字列表現を、このオブジェクトの文字列の指定された位置に挿入して、このオブジェクト自身を返します。
StringBuilder	insert(int index, char c) 指定された char 値だけからなる文字列を、このオブジェクトの文字列の指定された位置に挿入して、このオブジェクト自身を返します。
StringBuilder	insert(int index, char[] ca) 指定された char 配列の文字列を、このオブジェクトの文字列の指定された位置に挿入して、このオブジェクト自身を返します。
StringBuilder	insert(int index, int i) 指定された int 値の文字列表現を、このオブジェクトの文字列の指定された位置に挿入して、このオブジェクト自身を返します。
StringBuilder	insert(int index, long j) 指定された long 値の文字列表現を、このオブジェクトの文字列の指定された位置に挿入して、このオブジェクト自身を返します。
StringBuilder	insert(int index, Object obj) 指定された Object の文字列表現を、指定されたインデックスに挿入して、このオブジェクト自身を返します。
StringBuilder	insert(int index, String s) 指定された文字列を、このオブジェクトの文字列の指定された位置に挿入して、このオブジェクト自身を返します。
int	length() 文字数を返します。
void	replace(int start, int end, String string) このオブジェクトの文字列のインデックス start から end-1 までの部分文字列を、 string の文字列で置き換えます。
StringBuilder	reverse() このオブジェクトの文字列を逆順にして返します。
void	setCharAt(int index, char ch) 指定された文字を、このオブジェクトの文字列の指定された位置に設定します。
void	setLength(int n) 文字列の長さ（文字数）を設定します。
String	substring(int start, int end) このオブジェクトの文字列のインデックス start から end-1 までの部分文字列を表す String を生成して返します。
String	toString() このオブジェクトが現在保持している文字列を表す String を生成して返します。

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

equals, getClass, hashCode, notify, notifyAll, wait, wait

コンストラクタの詳細

StringBuilder

public StringBuilder()

16文字の容量を持つバッファの、空の文字列を保持する StringBuilder を生成します。

StringBuilder

public StringBuilder(String s)

指定された文字列を保持する StringBuilder を生成します。 指定された文字列＋16文字分のバッファが確保されます。

パラメータ:

s - 初期値とする文字列

例外:

NullPointerException - s が null の場合

StringBuilder

public StringBuilder(int capacity)

指定された文字数の容量を持つバッファの、空の文字列を保持する StringBuilder を生成します。

パラメータ:

capacity - バッファサイズの初期値

例外:

NegativeArraySizeException - capacity が負値の場合

メソッドの詳細

toString

public String toString()

このオブジェクトが現在保持している文字列を表す String を生成して返します。

オーバーライド:

クラス Object 内の toString

戻り値:

このオブジェクトが現在保持している文字列を表す String

append

public StringBuilder append(String str)

指定された String の文字列をこのオブジェクトの文字列の後に連結して、このオブジェクト自身を返します。 str が null の場合、 文字列 "null" が連結されます。

パラメータ:

str - 文字列

戻り値:

自オブジェクト

append

public StringBuilder append(char[] ca)

指定された char 配列の文字列をこのオブジェクトの文字列の後に連結して、このオブジェクト自身を返します。

パラメータ:

ca - 付加する文字列を保持する配列

戻り値:

自オブジェクト

append

public StringBuilder append(char[] ca,
                            int index,
                            int len)

指定された char 配列の部分文字列をこのオブジェクトの文字列の後に連結して、このオブジェクト自身を返します。

パラメータ:

ca - 付加する文字列を保持する配列

index - 付加する文字列の先頭を示すインデックス

len - 付加する文字列の文字数

戻り値:

自オブジェクト

capacity

public int capacity()

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

戻り値:

現在のバッファサイズ

ensureCapacity

public void ensureCapacity(int minCapacity)

最低限指定されたサイズのバッファ容量を確保します。 現在のバッファサイズが minCapacity より小さい場合、少なくとも minCapacity のサイズの文字列を保持できるだけのサイズのバッファを確保しなおします。 現在のバッファサイズが minCapacity より大きい場合は何もしません。

パラメータ:

minCapacity - 確保するバッファサイズ

append

public StringBuilder append(char c)

指定された文字をこのオブジェクトの文字列の後に連結して、このオブジェクト自身を返します。

パラメータ:

c - 付加する文字

戻り値:

自オブジェクト

insert

public StringBuilder insert(int index,
                            boolean b)

指定された boolean 値の文字列表現を、このオブジェクトの文字列の指定された位置に挿入して、このオブジェクト自身を返します。

String.valueOf(b) が、このオブジェクトが保持する文字列のオフセット index に挿入されます。

index は0以上で、かつこのオブジェクトの文字列の長さ（文字数）以下でなくてはなりません。

パラメータ:

index - 挿入する場所を示すインデックス

b - 挿入する値

戻り値:

自オブジェクト

例外:

StringIndexOutOfBoundsException - index が無効な値である場合

insert

public StringBuilder insert(int index,
                            char c)

指定された char 値だけからなる文字列を、このオブジェクトの文字列の指定された位置に挿入して、このオブジェクト自身を返します。

String.valueOf(c) が、このオブジェクトが保持する文字列のオフセット index に挿入されます。

index は0以上で、かつこのオブジェクトの文字列の長さ（文字数）以下でなくてはなりません。

パラメータ:

index - 挿入する場所を示すインデックス

c - 挿入する値

戻り値:

自オブジェクト

例外:

StringIndexOutOfBoundsException - index が無効な値である場合

insert

public StringBuilder insert(int index,
                            char[] ca)

指定された char 配列の文字列を、このオブジェクトの文字列の指定された位置に挿入して、このオブジェクト自身を返します。

String.valueOf(ca) が、このオブジェクトが保持する文字列のオフセット index に挿入されます。

index は0以上で、かつこのオブジェクトの文字列の長さ（文字数）以下でなくてはなりません。

パラメータ:

index - 挿入する場所を示すインデックス

ca - 挿入する文字列を保持する配列

戻り値:

自オブジェクト

例外:

StringIndexOutOfBoundsException - index が無効な値である場合

insert

public StringBuilder insert(int index,
                            int i)

指定された int 値の文字列表現を、このオブジェクトの文字列の指定された位置に挿入して、このオブジェクト自身を返します。

String.valueOf(i) が、このオブジェクトが保持する文字列のオフセット index に挿入されます。

index は0以上で、かつこのオブジェクトの文字列の長さ（文字数）以下でなくてはなりません。

パラメータ:

index - 挿入する場所を示すインデックス

i - 挿入する値

戻り値:

自オブジェクト

例外:

StringIndexOutOfBoundsException - index が無効な値である場合

insert

public StringBuilder insert(int index,
                            long j)

指定された long 値の文字列表現を、このオブジェクトの文字列の指定された位置に挿入して、このオブジェクト自身を返します。

String.valueOf(j) が、このオブジェクトが保持する文字列のオフセット index に挿入されます。

index は0以上で、かつこのオブジェクトの文字列の長さ（文字数）以下でなくてはなりません。

パラメータ:

index - 挿入する場所を示すインデックス

j - 挿入する値

戻り値:

自オブジェクト

例外:

StringIndexOutOfBoundsException - index が無効な値である場合

insert

public StringBuilder insert(int index,
                            Object obj)

指定された Object の文字列表現を、指定されたインデックスに挿入して、このオブジェクト自身を返します。

String.valueOf(obj) が、このオブジェクトが保持する文字列のオフセット index に挿入されます。

index は0以上で、かつこのオブジェクトの文字列の長さ（文字数）以下でなくてはなりません。

パラメータ:

index - 挿入する場所を示すインデックス

obj - 挿入する値

戻り値:

自オブジェクト

例外:

StringIndexOutOfBoundsException - index が無効な値である場合

insert

public StringBuilder insert(int index,
                            String s)

指定された文字列を、このオブジェクトの文字列の指定された位置に挿入して、このオブジェクト自身を返します。 s が null の場合、 文字列 "null" が挿入されます。

index は0以上で、かつこのオブジェクトの文字列の長さ（文字数）以下でなくてはなりません。

パラメータ:

index - 挿入する場所を示すインデックス

s - 挿入する値

戻り値:

自オブジェクト

例外:

StringIndexOutOfBoundsException - index が無効な値である場合

reverse

public StringBuilder reverse()

このオブジェクトの文字列を逆順にして返します。 サロゲートペアはサポートされていません。

戻り値:

自オブジェクト

setCharAt

public void setCharAt(int index,
                      char ch)

指定された文字を、このオブジェクトの文字列の指定された位置に設定します。

index は0以上で、かつこのオブジェクトの文字列の長さ（文字数）より小さな値でなくてはなりません。

パラメータ:

index - 文字を設定する場所を示すインデックス

ch - 設定する文字

例外:

IndexOutOfBoundsException - index が無効な値である場合

append

public StringBuilder append(int i)

指定された int 値の文字列表現をこのオブジェクトの文字列に付加して、このオブジェクト自身を返します。

Integer.toString(i) が、このオブジェクトが保持する文字列の後に付加されます。

パラメータ:

i - 付加する値

戻り値:

自オブジェクト

append

public StringBuilder append(boolean b)

指定された boolean 値の文字列表現をこのオブジェクトの文字列に付加して、このオブジェクト自身を返します。

b が true の場合 "true" 、 false の場合 "false" がこのオブジェクトが保持する文字列の後に付加されます。

パラメータ:

b - 付加する値

戻り値:

自オブジェクト

append

public StringBuilder append(Object o)

指定された Object の文字列表現をこのオブジェクトの文字列に付加して、このオブジェクト自身を返します。

o が null の場合 "null" 、それ以外の場合 o.toString() がこのオブジェクトが保持する文字列の後に付加されます。

パラメータ:

o - 付加するObject

戻り値:

自オブジェクト

append

public StringBuilder append(long lv)

指定された long 値の文字列表現をこのオブジェクトの文字列に付加して、このオブジェクト自身を返します。

Long.toString(lv) が、このオブジェクトが保持する文字列の後に付加されます。

パラメータ:

lv - 付加する値

戻り値:

自オブジェクト

delete

public StringBuilder delete(int start,
                            int end)

このオブジェクト中の、指定された範囲の部分文字列を削除して、このオブジェクト自身を返します。

削除する部分文字列は、インデックス start から end-1 までの文字列です。 ただし、 end がこのオブジェクトの文字列の長さ（文字数）以上の場合、インデックス start からこの文字列の最後までが削除されます。

start と end が等しい場合、削除は行われません。

パラメータ:

start - 削除を開始するインデックス

end - 削除を終了するインデックス。 end -1 まで削除されます。

戻り値:

自オブジェクト

例外:

StringIndexOutOfBoundsException - 以下のどれかの場合

• start < 0
• this.length() < start
• end < start

deleteCharAt

public StringBuilder deleteCharAt(int index)

指定されたインデックスの文字を削除して、このオブジェクト自身を返します。

このメソッドは指定されたインデックスにある文字がサロゲートペアの一部かどうかにかかわらず、その文字だけを削除します。 サロゲートペアを扱う必要がある場合はアプリケーション側で処理してください。

パラメータ:

index - 削除する文字の位置を示すインデックス

戻り値:

自オブジェクト

例外:

StringIndexOutOfBoundsException - 以下のどれかの場合

• index < 0
• this.length() <= index

length

public int length()

文字数を返します。

戻り値:

このオブジェクトが保持している文字列の文字数

setLength

public void setLength(int n)

文字列の長さ（文字数）を設定します。 n がこのオブジェクトの文字列の長さ以下の場合、新しい文字列は、現在の文字列のインデックス 0 から n-1 までの文字からなる文字列になります。 n がこのオブジェクトの文字列の長さより大きい場合、新しい文字列は、最初に現在の文字列があり、続いてインデックス n-1 まで null 文字 ( '\u0000' ) が設定された文字列になります。

パラメータ:

n - 新しい長さ

例外:

IndexOutOfBoundsException - n が負値の場合

charAt

public char charAt(int index)

指定されたインデックスにある文字を返します。 index は 0 から「このオブジェクトの文字列の文字数 - 1」までの値でなくてはなりません。

指定されたインデックスの文字がサロゲートペアの一部の場合、その値がそのまま返されます。

パラメータ:

index - 文字の位置を示すインデックス

戻り値:

指定されたインデックスにある文字

例外:

IndexOutOfBoundsException - index が負値であるかまたは this.length() 以上の値である場合

getChars

public void getChars(int st,
                     int ed,
                     char[] dst,
                     int dstst)

指定された範囲にある文字列を、指定された配列の指定された位置にコピーします。 index は 0 から「このオブジェクトの文字列の文字数 - 1」までの値でなくてはなりません。

このオブジェクトの文字列のインデックス st からインデックス ed-1 までの文字列を、配列 dst のインデックス dstst 以降にコピーします。

パラメータ:

st - コピーする文字列の先頭を示すインデックス

ed - コピーを終了する位置を示すインデックス。 ed-1 までをコピーします。

dst - コピー先の配列

dstst - コピー先の先頭を示すインデックス

例外:

NullPointerException - dst が null の場合

IndexOutOfBoundsException - 以下のどれかの場合

• st < 0
• dstst < 0
• ed < st
• this.length() < ed
• dst.length < dstst + ed - st

indexOf

public int indexOf(String string)

指定された文字列がこのオブジェクトの文字列中に最初に出現する位置を返します。

パラメータ:

string - 検索する文字列

戻り値:

string が最初に出現する、このオブジェクトの文字列中の位置。 出現しない場合 -1 。

例外:

NullPointerException - string が null の場合

indexOf

public int indexOf(String string,
                   int fromIndex)

指定された文字列がこのオブジェクトの文字列中に最初に出現する位置を返します。 fromIndex に負の値が指定された場合、0が指定された場合と同じ処理が行われます。

パラメータ:

string - 検索する文字列

fromIndex - 検索を開始する位置

戻り値:

このオブジェクトの文字列のインデックス fromIndex 以降で、 string が最初に出現する位置。 出現しない場合 -1 。

例外:

NullPointerException - string が null の場合

substring

public String substring(int start,
                        int end)

このオブジェクトの文字列のインデックス start から end-1 までの部分文字列を表す String を生成して返します。

パラメータ:

start - 部分文字列の開始位置

end - 部分文字列の終了位置。 end-1 までが部分文字列として使用されます。

戻り値:

部分文字列を表す String

例外:

StringIndexOutOfBoundsException - 以下の場合

• start < 0
• end < 0
• length < start
• length < end
• end < start

replace

public void replace(int start,
                    int end,
                    String string)

このオブジェクトの文字列のインデックス start から end-1 までの部分文字列を、 string の文字列で置き換えます。

end >= length() の場合、 delete(start, length()) コール後に append(string) をコールした場合と等価となります。

パラメータ:

start - 部分文字列の開始位置

end - 部分文字列の終了位置。 end-1 までが部分文字列であるとみなされます。 ただし、 end がこのオブジェクトの文字列の文字数より大きい場合、このオブジェクトの最後の文字までが部分文字列であるとみなされます。

string - 置き換える文字列を保持する String

例外:

StringIndexOutOfBoundsException - 以下の場合

• start < 0
• length() < start
• end < start