java.lang

クラス StringBuffer

java.lang.Object

java.lang.StringBuffer

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

Serializable, Appendable, CharSequence

public final class StringBuffer
extends Object
implements Serializable, CharSequence

スレッドセーフな可変の文字列。文字列バッファーは String に似ていますが、変更できる点が異なります。文字列バッファーには常に文字列が格納されていますが、文字列の長さと内容は特定のメソッドの呼び出しにより変更できます。

文字列バッファーは複数のスレッドによって安全に使用することができます。メソッドは必要に応じて同期化され、特定のインスタンスでのすべてのオペレーションが、関連のある個々のスレッドによって行われるメソッドの呼び出しの順序と一致する連続した順序で発生するように動作します。

StringBuffer の基本的なオペレーションには、append メソッドおよび insert メソッドがあり、これらのメソッドはどんな種類のデータも受け取ることができるようにオーバーロードされています。メソッドはそれぞれ与えられたデータを効率的に文字列に変換し、文字列中の文字を文字列バッファーに追加または挿入します。append メソッドは常に、バッファーの末尾に与えられた文字を追加し、insert メソッドは指定された位置に文字を追加します。

たとえば、z を、現在「start」を含む文字列バッファーオブジェクトと見なす場合、z.append("le") は文字列バッファーの内容が「startle」になるように変更するのに対して、z.insert(4, "le") というメソッド呼び出しは文字列バッファーの内容が「starlet」になるように作用します。

一般に、sb が StringBuffer のインスタンスを参照している場合、sb.append(x) は sb.insert(sb.length(), x) と同じ結果になります。

処理にソースシーケンスが関連する場合 (ソースシーケンスからの追加や挿入など)、このクラスは、その処理を実行している文字列バッファーとだけ同期化し、ソースとは同期化しません。

各文字列バッファーには容量があります。文字列バッファーに含まれる文字列の長さが容量を超過しないかぎり、新しい内部バッファー配列を割り当てる必要はありません。内部バッファーがオーバーフローする場合、自動的に容量が増加します。 JDK 5 以降、このクラスは単一のスレッド StringBuilder により使用されるよう設計された等価のクラスで補足されています。 StringBuilder クラスは、このクラスと同じ処理をすべてサポートしながらも高速であり、同期を実行しないので、通常はこのクラスに優先して使用される必要があります。

導入されたバージョン:

JDK1.0

関連項目:

StringBuilder, String, 直列化された形式

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

コンストラクタ

コンストラクタと説明
StringBuffer() 文字を持たず、初期容量が 16 文字である文字列バッファーを構築します。
StringBuffer(CharSequence seq) 指定された CharSequence 引数と同じ文字を含む文字列バッファーを構築します。
StringBuffer(int capacity) 文字を持たず、指定された初期容量を持つ文字列バッファーを構築します。
StringBuffer(String str) 指定された文字列の内容に初期化された文字列バッファーを構築します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
StringBuffer	append(boolean b) boolean 引数の文字列表現をシーケンスに追加します。
StringBuffer	append(char c) char 引数の文字列表現をこのシーケンスに追加します。
StringBuffer	append(char[] str) char 配列引数の文字列表現をこのシーケンスに追加します。
StringBuffer	append(char[] str, int offset, int len) char 配列引数の部分配列の文字列表現を、このシーケンスに追加します。
StringBuffer	append(CharSequence s) 指定された CharSequence をこのシーケンスに追加します。
StringBuffer	append(CharSequence s, int start, int end) 指定された CharSequence のサブシーケンスをこのシーケンスに追加します。
StringBuffer	append(double d) double 引数の文字列表現をこのシーケンスに追加します。
StringBuffer	append(float f) float 引数の文字列表現をこのシーケンスに追加します。
StringBuffer	append(int i) int 引数の文字列表現をこのシーケンスに追加します。
StringBuffer	append(long lng) long 引数の文字列表現をこのシーケンスに追加します。
StringBuffer	append(Object obj) Object 引数の文字列表現を追加します。
StringBuffer	append(String str) 指定された文字列をこの文字シーケンスに追加します。
StringBuffer	append(StringBuffer sb) 指定された StringBuffer をこのシーケンスに追加します。
StringBuffer	appendCodePoint(int codePoint) codePoint 引数の文字列表現をこのシーケンスに追加します。
int	capacity() 現在の容量を返します。
char	charAt(int index) このシーケンス内の指定されたインデックスの char 値を返します。
int	codePointAt(int index) 指定されたインデックス位置の文字 (Unicode コードポイント) を返します。
int	codePointBefore(int index) 指定されたインデックスの前の文字 (Unicode コードポイント) を返します。
int	codePointCount(int beginIndex, int endIndex) このシーケンスの指定されたテキスト範囲に含まれる Unicode コードポイントの数を返します。
StringBuffer	delete(int start, int end) このシーケンスの部分文字列内の文字を削除します。
StringBuffer	deleteCharAt(int index) このシーケンス内の指定された位置にある char を削除します。
void	ensureCapacity(int minimumCapacity) 容量が必ず指定された最小値以上になるようにします。
void	getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin) このシーケンスからコピー先の文字配列 dst に文字がコピーされます。
int	indexOf(String str) この文字列内で、指定された部分文字列が最初に出現する位置のインデックスを返します。
int	indexOf(String str, int fromIndex) 指定されたインデックス以降で、指定された部分文字列がこの文字列内で最初に出現する位置のインデックスを返します。
StringBuffer	insert(int offset, boolean b) boolean 引数の文字列表現をこのシーケンスに挿入します。
StringBuffer	insert(int offset, char c) char 引数の文字列表現をこのシーケンスに挿入します。
StringBuffer	insert(int offset, char[] str) char 配列引数の文字列表現をこのシーケンスに挿入します。
StringBuffer	insert(int index, char[] str, int offset, int len) str 配列引数の部分配列の文字列表現を、このシーケンスに挿入します。
StringBuffer	insert(int dstOffset, CharSequence s) 指定された CharSequence をこのシーケンスに挿入します。
StringBuffer	insert(int dstOffset, CharSequence s, int start, int end) 指定された CharSequence のサブシーケンスをこのシーケンスに挿入します。
StringBuffer	insert(int offset, double d) double 引数の文字列表現をこのシーケンスに挿入します。
StringBuffer	insert(int offset, float f) float 引数の文字列表現をこのシーケンスに挿入します。
StringBuffer	insert(int offset, int i) 2 番目の int 引数の文字列表現をこのシーケンスに挿入します。
StringBuffer	insert(int offset, long l) long 引数の文字列表現をこのシーケンスに挿入します。
StringBuffer	insert(int offset, Object obj) Object 引数の文字列表現をこの文字シーケンスに挿入します。
StringBuffer	insert(int offset, String str) 文字列をこの文字シーケンスに挿入します。
int	lastIndexOf(String str) この文字列内で、指定された部分文字列が一番右に出現する位置のインデックスを返します。
int	lastIndexOf(String str, int fromIndex) この文字列内で、指定された部分文字列が最後に出現する位置のインデックスを返します。
int	length() 長さ (文字数) を返します。
int	offsetByCodePoints(int index, int codePointOffset) このシーケンス内で、指定された index から codePointOffset コードポイント分だけオフセットされた位置のインデックスを返します。
StringBuffer	replace(int start, int end, String str) このシーケンスの部分文字列内の文字を、指定された String 内の文字で置き換えます。
StringBuffer	reverse() この文字シーケンスを、シーケンスの順序を逆にしたもので置き換えます。
void	setCharAt(int index, char ch) 指定されたインデックスの文字が ch に設定されます。
void	setLength(int newLength) 文字シーケンスの長さを設定します。
CharSequence	subSequence(int start, int end) このシーケンスのサブシーケンスである新規文字シーケンスを返します。
String	substring(int start) この文字シーケンスに現在含まれている文字の部分シーケンスを含む新しい String を返します。
String	substring(int start, int end) このシーケンスに現在含まれている文字の部分シーケンスを含む新しい String を返します。
String	toString() このシーケンス内のデータを表す文字列を返します。
void	trimToSize() この文字シーケンスで使用されているストレージの低減を試みます。

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

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

コンストラクタの詳細

StringBuffer

public StringBuffer()

文字を持たず、初期容量が 16 文字である文字列バッファーを構築します。

StringBuffer

public StringBuffer(int capacity)

文字を持たず、指定された初期容量を持つ文字列バッファーを構築します。

パラメータ:

capacity - 初期容量。

例外:

NegativeArraySizeException - capacity 引数が 0 未満の場合。

StringBuffer

public StringBuffer(String str)

指定された文字列の内容に初期化された文字列バッファーを構築します。文字列バッファーの初期容量は、16 に文字列引数の長さを加えたものです。

パラメータ:

str - バッファーの初期内容。

例外:

NullPointerException - str が null である場合

StringBuffer

public StringBuffer(CharSequence seq)

指定された CharSequence 引数と同じ文字を含む文字列バッファーを構築します。文字列バッファーの初期容量は、16 に CharSequence 引数の長さを加えたものです。

指定された CharSequence の長さがゼロ以下の場合、容量 16 の空のバッファーが返されます。

パラメータ:

seq - コピー対象のシーケンス。

例外:

NullPointerException - seq が null である場合

導入されたバージョン:

1.5

メソッドの詳細

length

public int length()

長さ (文字数) を返します。

定義:

length、インタフェース: CharSequence

戻り値:

このオブジェクトによって現在表される文字シーケンスの長さ

capacity

public int capacity()

現在の容量を返します。容量とは、新しく挿入される文字で使用可能なストレージの量のことであり、それを超えると割り当てが発生します。

戻り値:

現在の容量

ensureCapacity

public void ensureCapacity(int minimumCapacity)

容量が必ず指定された最小値以上になるようにします。現在の容量が引数より小さい場合、より多くの容量を持つ新しい内部配列が割り当てられます。新しい容量は、次の大きいほうになります。

• minimumCapacity 引数。
• 以前の容量の 2 倍の量に 2 を加えた値。

minimumCapacity 引数が正の値でない場合、このメソッドは何も行わずに復帰します。

パラメータ:

minimumCapacity 保証したい最小容量。

trimToSize

public void trimToSize()

この文字シーケンスで使用されているストレージの低減を試みます。バッファーが現在の文字シーケンスを保持するのに必要なサイズよりも大きい場合、そのサイズを変更して容量効率を高めることができます。このメソッドを呼び出すと、あとで capacity() メソッドを呼び出した際に返される値に影響する可能性がありますが、必ずそうとはかぎりません。

導入されたバージョン:

1.5

setLength

public void setLength(int newLength)

文字シーケンスの長さを設定します。このシーケンスが、引数で指定された長さの新しい文字シーケンスに変更されます。newLength より小さいすべての負でないインデックス k について、k が以前の文字シーケンスの長さより小さい場合、新しい文字シーケンス内のインデックス k の文字は、以前のシーケンス内のインデックス k の文字と同じになります。それ以外の場合、それは null 文字 '\u0000' になります。 つまり、newLength 引数が現在の長さより小さい場合、その長さが指定された長さに変更されます。

newLength 引数が現在の長さと等しいかそれより大きい場合は、長さが newLength 引数になるように、十分な数の null 文字 ('\u0000') が追加されます。

newLength 引数は 0 以上でなければなりません。

パラメータ:

newLength - 新しい長さ

例外:

IndexOutOfBoundsException - newLength 引数が負の場合。

関連項目:

length()

charAt

public char charAt(int index)

このシーケンス内の指定されたインデックスの char 値を返します。配列のインデックスと同様に、最初の char 値の位置がインデックス 0、次の文字の位置が 1、といった具合になります。

index 引数は、0 以上で、このシーケンスの長さより小さくなければなりません。

インデックスで指定された char 値がサロゲートの場合、サロゲート値が返されます。

定義:

charAt、インタフェース: CharSequence

パラメータ:

index - 目的の char 値のインデックス。

戻り値:

指定されたインデックスの char 値。

例外:

IndexOutOfBoundsException - index が負の値の場合、あるいは length() に等しいかこれより大きい場合。

関連項目:

length()

codePointAt

public int codePointAt(int index)

指定されたインデックス位置の文字 (Unicode コードポイント) を返します。インデックスは char 値 (Unicode コード単位) を参照し、その範囲は 0 - length() - 1 になります。

指定されたインデックスで指定された char 値が上位サロゲート範囲にあり、それに続くインデックスがこのシーケンスの長さ未満で、以降のインデックスの char 値が下位サロゲート範囲にある場合、このサロゲートペアに対応する補助コードポイントが返されます。それ以外の場合は、指定されたインデックスにある char 値が返されます。

パラメータ:

index - char 値へのインデックス

戻り値:

指定された index にある文字のコードポイント値

導入されたバージョン:

1.5

codePointBefore

public int codePointBefore(int index)

指定されたインデックスの前の文字 (Unicode コードポイント) を返します。インデックスは char 値 (Unicode コード単位) を参照し、その範囲は 1 - length() になります。

(index - 1) の char 値が下位サロゲート範囲に含まれており、(index - 2) が負でなく、かつ (index - 2) の char 値が上位サロゲートに含まれている場合、そのサロゲートペアの補助コードポイント値が返されます。index - 1 の char 値が、ペアになっていない下位サロゲートであるか、または上位サロゲートである場合、そのサロゲート値が返されます。

パラメータ:

index - 返すべきコードポイントの直後のインデックス

戻り値:

指定されたインデックスの前にある Unicode コードポイント値。

導入されたバージョン:

1.5

codePointCount

public int codePointCount(int beginIndex,
                 int endIndex)

このシーケンスの指定されたテキスト範囲に含まれる Unicode コードポイントの数を返します。テキスト範囲は、指定された beginIndex からインデックス endIndex - 1 の位置の char までです。したがって、テキスト範囲の長さ (char 数) は、endIndex-beginIndex になります。このシーケンス内でペアになっていないサロゲートは、それぞれ 1 つのコードポイントとして数えられます。

パラメータ:

beginIndex - テキスト範囲内の最初の char へのインデックス。

endIndex - テキスト範囲内の最後の char の直後のインデックス。

戻り値:

指定されたテキスト範囲内の Unicode コードポイントの数

導入されたバージョン:

1.5

offsetByCodePoints

public int offsetByCodePoints(int index,
                     int codePointOffset)

このシーケンス内で、指定された index から codePointOffset コードポイント分だけオフセットされた位置のインデックスを返します。index と codePointOffset で指定されるテキスト範囲内でペアになっていないサロゲートは、それぞれ 1 つのコードポイントとして数えられます。

パラメータ:

index - オフセットされるインデックス

codePointOffset - オフセット (コードポイント数)

戻り値:

このシーケンス内でのインデックス

導入されたバージョン:

1.5

getChars

public void getChars(int srcBegin,
            int srcEnd,
            char[] dst,
            int dstBegin)

このシーケンスからコピー先の文字配列 dst に文字がコピーされます。コピーする最初の文字はインデックス srcBegin、コピーする最後の文字はインデックス srcEnd-1 になります。コピーする文字の合計数は srcEnd-srcBegin です。文字は dst の部分配列にコピーされます。始点のインデックスは dstBegin で、終点のインデックスは次のようになります。

 dstbegin + (srcEnd-srcBegin) - 1
 

パラメータ:

srcBegin - このオフセットからコピーを開始する。

srcEnd - このオフセットでコピーを停止する。

dst - データのコピー先の配列。

dstBegin - dst へのオフセット。

例外:

NullPointerException - dst が null である場合。

IndexOutOfBoundsException - 次のどれかに当てはまる場合。

• srcBegin が負である
• dstBegin が負である
• srcBegin 引数が srcEnd 引数より大きい
• srcEnd が this.length() より大きい
• dstBegin+srcEnd-srcBegin が次より大きい: dst.length

setCharAt

public void setCharAt(int index,
             char ch)

指定されたインデックスの文字が ch に設定されます。このシーケンスは、位置 index の文字が ch である点を除き、以前の文字シーケンスと同一であるような、新しい文字シーケンスを表現するように変更されます。

index 引数は、0 以上で、このシーケンスの長さより小さくなければなりません。

パラメータ:

index - 変更対象の文字のインデックス。

ch - 新しい文字。

例外:

IndexOutOfBoundsException - index が負の値の場合、あるいは length() に等しいかこれより大きい場合。

関連項目:

length()

append

public StringBuffer append(Object obj)

Object 引数の文字列表現を追加します。

最終的には、String.valueOf(Object) メソッドによって引数が文字列に変換されてから、その文字列の文字がこの文字シーケンスに追加された場合とまったく同じ結果になります。

パラメータ:

obj - Object。

戻り値:

このオブジェクトへの参照。

append

public StringBuffer append(String str)

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

String 引数の文字は、順番に追加され、引数の長さの分だけこのシーケンスの長さが増えます。str が null の場合は、"null" という 4 文字が追加されます。

append メソッドの実行直前に、この文字シーケンスの長さが n であったとします。このとき、新しい文字シーケンス内のインデックス k の文字は、k が n より小さい場合は以前の文字シーケンス内のインデックス k の文字と等しくなり、それ以外の場合は引数 str 内のインデックス k-n の文字と等しくなります。

パラメータ:

str - 文字列。

戻り値:

このオブジェクトへの参照。

append

public StringBuffer append(StringBuffer sb)

指定された StringBuffer をこのシーケンスに追加します。

StringBuffer 引数の文字が、順番にこの StringBuffer の内容に追加されます。その結果、引数の長さの分だけこの StringBuffer の長さが増えます。sb が null の場合は、この StringBuffer に「null」という 4 文字が追加されます。

append メソッドの実行の直前に StringBuffer に格納されていた文字列の長さが n であるとします。このとき、新しい文字シーケンス内のインデックス k の文字は、k が n より小さい場合は以前の文字シーケンス内のインデックス k の文字と等しくなり、それ以外の場合は引数 sb 内のインデックス k-n の文字と等しくなります。

このメソッドは、this (追加先) オブジェクトと同期しますが、ソース (sb) とは同期しません。

パラメータ:

sb - 追加する StringBuffer。

戻り値:

このオブジェクトへの参照。

導入されたバージョン:

1.4

append

public StringBuffer append(CharSequence s)

指定された CharSequence をこのシーケンスに追加します。

CharSequence 引数の文字は、順番に追加され、引数の長さの分だけこのシーケンスの長さが増えます。

このメソッドの結果は、this.append(s, 0, s.length()); の呼び出しとまったく同じです。

このメソッドは、この (追加先) オブジェクトと同期しますが、ソース (s) とは同期しません。

s が null の場合は、"null" という 4 文字が追加されます。

定義:

append、インタフェース: Appendable

パラメータ:

s - 追加する CharSequence。

戻り値:

このオブジェクトへの参照。

導入されたバージョン:

1.5

append

public StringBuffer append(CharSequence s,
                  int start,
                  int end)

指定された CharSequence のサブシーケンスをこのシーケンスに追加します。

引数 s のインデックス start からインデックス end -1 までの文字が、このシーケンスの内容に順番に追加されます。このシーケンスの長さは end - start の値だけ増えます。

append メソッドの実行直前に、この文字シーケンスの長さが n であったとします。このとき、この文字シーケンス内のインデックス k の文字は、k が n より小さい場合はこのシーケンス内のインデックス k の文字と等しくなり、それ以外の場合は引数 s 内のインデックス k+start-n の文字と等しくなります。

s が null の場合、このメソッドは s パラメータが "null" という 4 文字を含むシーケンスであるかのように、文字を追加します。

定義:

append、インタフェース: Appendable

パラメータ:

s - 追加されるシーケンス。

start - 追加される部分シーケンスの開始インデックス。

end - 追加される部分シーケンスの終了インデックス。

戻り値:

このオブジェクトへの参照。

例外:

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

導入されたバージョン:

1.5

append

public StringBuffer append(char[] str)

char 配列引数の文字列表現をこのシーケンスに追加します。

配列引数の文字がこのシーケンスの内容に順番に追加されます。このシーケンスの長さは、引数の長さの分だけ増えます。

最終的には、String.valueOf(char[]) メソッドによって引数が文字列に変換されてから、その文字列の文字がこの文字シーケンスに追加された場合とまったく同じ結果になります。

パラメータ:

str - 追加される文字。

戻り値:

このオブジェクトへの参照。

append

public StringBuffer append(char[] str,
                  int offset,
                  int len)

char 配列引数の部分配列の文字列表現を、このシーケンスに追加します。

char 配列 str のインデックス offset 以降の文字が、このシーケンスの内容に順番に追加されます。このシーケンスの長さは len の値だけ増えます。

最終的には、String.valueOf(char[],int,int) メソッドによって引数が文字列に変換されてから、その文字列の文字がこの文字シーケンスに追加された場合とまったく同じ結果になります。

パラメータ:

str - 追加される文字。

offset - 追加される最初の char のインデックス。

len - 追加される char の数。

戻り値:

このオブジェクトへの参照。

例外:

IndexOutOfBoundsException - offset < 0 または len < 0 または offset+len > str.length の場合

append

public StringBuffer append(boolean b)

boolean 引数の文字列表現をシーケンスに追加します。

最終的には、String.valueOf(boolean) メソッドによって引数が文字列に変換されてから、その文字列の文字がこの文字シーケンスに追加された場合とまったく同じ結果になります。

パラメータ:

b - boolean。

戻り値:

このオブジェクトへの参照。

append

public StringBuffer append(char c)

char 引数の文字列表現をこのシーケンスに追加します。

引数がこのシーケンスの内容に追加されます。このシーケンスの長さは 1 だけ増えます。

最終的には、String.valueOf(char) メソッドによって引数が文字列に変換されてから、その文字列の文字がこの文字シーケンスに追加された場合とまったく同じ結果になります。

定義:

append、インタフェース: Appendable

パラメータ:

c - char。

戻り値:

このオブジェクトへの参照。

append

public StringBuffer append(int i)

int 引数の文字列表現をこのシーケンスに追加します。

最終的には、String.valueOf(int) メソッドによって引数が文字列に変換されてから、その文字列の文字がこの文字シーケンスに追加された場合とまったく同じ結果になります。

パラメータ:

i - int。

戻り値:

このオブジェクトへの参照。

appendCodePoint

public StringBuffer appendCodePoint(int codePoint)

codePoint 引数の文字列表現をこのシーケンスに追加します。

引数がこのシーケンスの内容に追加されます。このシーケンスの長さは Character.charCount(codePoint) だけ増えます。

最終的には、Character.toChars(int) メソッドによって引数が char 配列に変換されてから、その配列の文字がこの文字シーケンスに追加された場合とまったく同じ結果になります。

パラメータ:

codePoint - Unicode コードポイント

戻り値:

このオブジェクトへの参照。

導入されたバージョン:

1.5

append

public StringBuffer append(long lng)

long 引数の文字列表現をこのシーケンスに追加します。

最終的には、String.valueOf(long) メソッドによって引数が文字列に変換されてから、その文字列の文字がこの文字シーケンスに追加された場合とまったく同じ結果になります。

パラメータ:

lng - long。

戻り値:

このオブジェクトへの参照。

append

public StringBuffer append(float f)

float 引数の文字列表現をこのシーケンスに追加します。

最終的には、String.valueOf(float) メソッドによって引数が文字列に変換されてから、その文字列の文字がこの文字シーケンスに追加された場合とまったく同じ結果になります。

パラメータ:

f - float。

戻り値:

このオブジェクトへの参照。

append

public StringBuffer append(double d)

double 引数の文字列表現をこのシーケンスに追加します。

最終的には、String.valueOf(double) メソッドによって引数が文字列に変換されてから、その文字列の文字がこの文字シーケンスに追加された場合とまったく同じ結果になります。

パラメータ:

d - double。

戻り値:

このオブジェクトへの参照。

delete

public StringBuffer delete(int start,
                  int end)

このシーケンスの部分文字列内の文字を削除します。部分文字列は、指定された start から始まり、インデックス end - 1 の文字までになりますが、そのような文字が存在しない場合はシーケンスの末尾までになります。start が end に等しい場合、変更は一切行われません。

パラメータ:

start - 開始インデックス (この値を含む)。

end - 終了インデックス (この値を含まない)。

戻り値:

このオブジェクト。

例外:

StringIndexOutOfBoundsException - start が負の値の場合、length() より大きい場合、あるいは end より大きい場合。

導入されたバージョン:

1.2

deleteCharAt

public StringBuffer deleteCharAt(int index)

このシーケンス内の指定された位置にある char を削除します。このシーケンスは 1 char 分だけ短くなります。

注: 指定されたインデックスの文字が補助文字であっても、このメソッドはその文字全体を削除しません。補助文字の処理を正しく行う必要がある場合は、Character.charCount(thisSequence.codePointAt(index)) (thisSequence はこのシーケンス) を呼び出して、削除される char の数を確認します。

パラメータ:

index - 削除される char のインデックス

戻り値:

このオブジェクト。

例外:

StringIndexOutOfBoundsException - index が負の値の場合、あるいは length() に等しいかこれより大きい場合。

導入されたバージョン:

1.2

replace

public StringBuffer replace(int start,
                   int end,
                   String str)

このシーケンスの部分文字列内の文字を、指定された String 内の文字で置き換えます。部分文字列は、指定された start から始まり、インデックス end - 1 の文字までになりますが、そのような文字が存在しない場合はシーケンスの末尾までになります。まず、部分文字列内の文字が削除され、続いて、指定された String が start の位置に挿入されます。(必要であれば、指定された String に合わせてこのシーケンスの長さが調整されます。)

パラメータ:

start - 開始インデックス (この値を含む)。

end - 終了インデックス (この値を含まない)。

str - 以前の内容を置換する String。

戻り値:

このオブジェクト。

例外:

StringIndexOutOfBoundsException - start が負の値の場合、length() より大きい場合、あるいは end より大きい場合。

導入されたバージョン:

1.2

substring

public String substring(int start)

この文字シーケンスに現在含まれている文字の部分シーケンスを含む新しい String を返します。部分文字列は指定されたインデックスで始まり、このシーケンスの末尾までになります。

パラメータ:

start - 開始インデックス (この値を含む)。

戻り値:

新しい文字列。

例外:

StringIndexOutOfBoundsException - start が 0 より小さい場合、あるいはこのオブジェクトの長さより大きい場合。

導入されたバージョン:

1.2

subSequence

public CharSequence subSequence(int start,
                       int end)

このシーケンスのサブシーケンスである新規文字シーケンスを返します。

次のフォームのメソッド呼び出しは、

 sb.subSequence(begin, end)

次の呼び出しと正確に同じ動作になります。

 sb.substring(begin, end)

このメソッドが提供されているのは、このクラスが CharSequence インタフェースを実装できるようにするためです。

定義:

subSequence、インタフェース: CharSequence

パラメータ:

start - 開始インデックス (この値を含む)。

end - 終了インデックス (この値を含まない)。

戻り値:

指定されたサブシーケンス。

例外:

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

導入されたバージョン:

1.4

substring

public String substring(int start,
               int end)

このシーケンスに現在含まれている文字の部分シーケンスを含む新しい String を返します。部分文字列は、指定された start から始まり、インデックス end - 1 にある文字までです。

パラメータ:

start - 開始インデックス (この値を含む)。

end - 終了インデックス (この値を含まない)。

戻り値:

新しい文字列。

例外:

StringIndexOutOfBoundsException - start または end が負の値であるか length() より大きい場合、または start が end より大きい場合。

導入されたバージョン:

1.2

insert

public StringBuffer insert(int index,
                  char[] str,
                  int offset,
                  int len)

str 配列引数の部分配列の文字列表現を、このシーケンスに挿入します。部分配列は、指定された offset から len char 個分になります。このシーケンス内の index で示される位置に部分配列の文字が挿入されます。このシーケンスの長さは、len 個の char 分だけ増えます。

パラメータ:

index - 部分配列を挿入する位置。

str - char 配列。

offset - 挿入される部分配列の最初の char のインデックス。

len - 挿入される部分配列の char 数。

戻り値:

このオブジェクト

例外:

StringIndexOutOfBoundsException - index が負の値であるか length() より大きい場合、offset または len が負の値の場合、あるいは (offset+len) が str.length より大きい場合。

導入されたバージョン:

1.2

insert

public StringBuffer insert(int offset,
                  Object obj)

Object 引数の文字列表現をこの文字シーケンスに挿入します。

最終的には、String.valueOf(Object) メソッドによって 2 番目の引数が文字列に変換されてから、その文字列の文字がこの文字シーケンス内の指定されたオフセット位置に挿入された場合とまったく同じ結果になります。

offset 引数は 0 に等しいかそれより大きく、このシーケンスの長さに等しいかこれより小さくなければなりません。

パラメータ:

offset - オフセット。

obj - Object。

戻り値:

このオブジェクトへの参照。

例外:

StringIndexOutOfBoundsException - オフセットが無効な場合。

insert

public StringBuffer insert(int offset,
                  String str)

文字列をこの文字シーケンスに挿入します。

このシーケンスの指定されたオフセット位置に String 引数の文字が順番に挿入され、その位置にもともとあった文字はすべて上方に移動され、このシーケンスの長さが引数の長さ分だけ増加します。str が null の場合は、"null" という 4 文字がこのシーケンスに挿入されます。

新しい文字列のインデックス k の位置にある文字は、次の文字に等しくなります。

• k が offset より小さい場合は、以前の文字シーケンス内のインデックス k の位置にある文字
• k が offset より小さくはないが、offset+str.length() より小さい場合は、引数 str 内のインデックス k-offset の位置にある文字
• k が offset+str.length() より小さくない場合は、以前の文字シーケンス内のインデックス k-str.length() の位置にある文字

offset 引数は 0 に等しいかそれより大きく、このシーケンスの長さに等しいかこれより小さくなければなりません。

パラメータ:

offset - オフセット。

str - 文字列。

戻り値:

このオブジェクトへの参照。

例外:

StringIndexOutOfBoundsException - オフセットが無効な場合。

insert

public StringBuffer insert(int offset,
                  char[] str)

char 配列引数の文字列表現をこのシーケンスに挿入します。

このシーケンスの内容の offset で示された位置に、配列引数の文字が挿入されます。このシーケンスの長さは、引数の長さの分だけ増えます。

最終的には、String.valueOf(char[]) メソッドによって 2 番目の引数が文字列に変換されてから、その文字列の文字がこの文字シーケンス内の指定されたオフセット位置に挿入された場合とまったく同じ結果になります。

offset 引数は 0 に等しいかそれより大きく、このシーケンスの長さに等しいかこれより小さくなければなりません。

パラメータ:

offset - オフセット。

str - 文字配列。

戻り値:

このオブジェクトへの参照。

例外:

StringIndexOutOfBoundsException - オフセットが無効な場合。

insert

public StringBuffer insert(int dstOffset,
                  CharSequence s)

指定された CharSequence をこのシーケンスに挿入します。

このシーケンスの指定されたオフセット位置に CharSequence 引数の文字が順番に挿入され、その位置にもともとあった文字がすべて上方に移動され、このシーケンスの長さが引数 s の長さ分だけ増加します。

このメソッドの結果は、このオブジェクトの insert(dstOffset, s, 0, s.length()) メソッドの呼び出しとまったく同じです。

s が null の場合は、"null" という 4 文字がこのシーケンスに挿入されます。

パラメータ:

dstOffset - オフセット。

s - 挿入されるシーケンス

戻り値:

このオブジェクトへの参照。

例外:

IndexOutOfBoundsException - オフセットが無効な場合。

導入されたバージョン:

1.5

insert

public StringBuffer insert(int dstOffset,
                  CharSequence s,
                  int start,
                  int end)

指定された CharSequence のサブシーケンスをこのシーケンスに挿入します。

start と end で指定される引数 s の部分シーケンスが、このシーケンス内の指定された挿入先 offset に順番に挿入され、その位置にもともとあった文字はすべて上方に移動されます。このシーケンスの長さは end - start だけ増えます。

このシーケンス内のインデックス k の位置にある文字は、次に等しくなります。

• k が dstOffset より小さい場合は、このシーケンス内のインデックス k の位置にある文字
• k が dstOffset に等しいかそれより大きく、dstOffset+end-start より小さい場合は、引数 s 内のインデックス k+start-dstOffset の位置にある文字
• k が dstOffset+end-start に等しいかそれより大きい場合は、このシーケンス内のインデックス k-(end-start) の位置にある文字

dstOffset 引数は 0 に等しいかそれより大きく、このシーケンスの長さに等しいかこれより小さくなければなりません。

start 引数は負でない値でなければならず、end より大きくてはいけません。

end 引数は、start に等しいかそれより大きく、s の長さに等しいかそれより小さくなければなりません。

s が null の場合、このメソッドは s パラメータが "null" という 4 文字を含むシーケンスであるかのように、文字を挿入します。

パラメータ:

dstOffset - このシーケンス内のオフセット。

s - 挿入されるシーケンス。

start - 挿入される部分シーケンスの開始インデックス。

end - 挿入される部分シーケンスの終了インデックス。

戻り値:

このオブジェクトへの参照。

例外:

IndexOutOfBoundsException - dstOffset が負の値であるか this.length() より大きい場合、start または end が負の値の場合、start が end より大きい場合、あるいは end が s.length() より大きい場合

導入されたバージョン:

1.5

insert

public StringBuffer insert(int offset,
                  boolean b)

boolean 引数の文字列表現をこのシーケンスに挿入します。

最終的には、String.valueOf(boolean) メソッドによって 2 番目の引数が文字列に変換されてから、その文字列の文字がこの文字シーケンス内の指定されたオフセット位置に挿入された場合とまったく同じ結果になります。

offset 引数は 0 に等しいかそれより大きく、このシーケンスの長さに等しいかこれより小さくなければなりません。

パラメータ:

offset - オフセット。

b - boolean。

戻り値:

このオブジェクトへの参照。

例外:

StringIndexOutOfBoundsException - オフセットが無効な場合。

insert

public StringBuffer insert(int offset,
                  char c)

char 引数の文字列表現をこのシーケンスに挿入します。

最終的には、String.valueOf(char) メソッドによって 2 番目の引数が文字列に変換されてから、その文字列の文字がこの文字シーケンス内の指定されたインデックス位置に挿入された場合とまったく同じ結果になります。

offset 引数は 0 に等しいかそれより大きく、このシーケンスの長さに等しいかこれより小さくなければなりません。

パラメータ:

offset - オフセット。

c - char。

戻り値:

このオブジェクトへの参照。

例外:

IndexOutOfBoundsException - オフセットが無効な場合。

insert

public StringBuffer insert(int offset,
                  int i)

2 番目の int 引数の文字列表現をこのシーケンスに挿入します。

最終的には、String.valueOf(int) メソッドによって 2 番目の引数が文字列に変換されてから、その文字列の文字がこの文字シーケンス内の指定されたオフセット位置に挿入された場合とまったく同じ結果になります。

offset 引数は 0 に等しいかそれより大きく、このシーケンスの長さに等しいかこれより小さくなければなりません。

パラメータ:

offset - オフセット。

i - int。

戻り値:

このオブジェクトへの参照。

例外:

StringIndexOutOfBoundsException - オフセットが無効な場合。

insert

public StringBuffer insert(int offset,
                  long l)

long 引数の文字列表現をこのシーケンスに挿入します。

最終的には、String.valueOf(long) メソッドによって 2 番目の引数が文字列に変換されてから、その文字列の文字がこの文字シーケンス内の指定されたオフセット位置に挿入された場合とまったく同じ結果になります。

offset 引数は 0 に等しいかそれより大きく、このシーケンスの長さに等しいかこれより小さくなければなりません。

パラメータ:

offset - オフセット。

l - long。

戻り値:

このオブジェクトへの参照。

例外:

StringIndexOutOfBoundsException - オフセットが無効な場合。

insert

public StringBuffer insert(int offset,
                  float f)

float 引数の文字列表現をこのシーケンスに挿入します。

最終的には、String.valueOf(float) メソッドによって 2 番目の引数が文字列に変換されてから、その文字列の文字がこの文字シーケンス内の指定されたオフセット位置に挿入された場合とまったく同じ結果になります。

offset 引数は 0 に等しいかそれより大きく、このシーケンスの長さに等しいかこれより小さくなければなりません。

パラメータ:

offset - オフセット。

f - float。

戻り値:

このオブジェクトへの参照。

例外:

StringIndexOutOfBoundsException - オフセットが無効な場合。

insert

public StringBuffer insert(int offset,
                  double d)

double 引数の文字列表現をこのシーケンスに挿入します。

最終的には、String.valueOf(double) メソッドによって 2 番目の引数が文字列に変換されてから、その文字列の文字がこの文字シーケンス内の指定されたオフセット位置に挿入された場合とまったく同じ結果になります。

offset 引数は 0 に等しいかそれより大きく、このシーケンスの長さに等しいかこれより小さくなければなりません。

パラメータ:

offset - オフセット。

d - double。

戻り値:

このオブジェクトへの参照。

例外:

StringIndexOutOfBoundsException - オフセットが無効な場合。

indexOf

public int indexOf(String str)

この文字列内で、指定された部分文字列が最初に出現する位置のインデックスを返します。返される整数は、次を満たす最小値 k になります。

 this.toString().startsWith(str, k)
 

が true である。

パラメータ:

str - 任意の文字列。

戻り値:

文字列引数がこのオブジェクト内の部分文字列である場合は、該当する最初の部分文字列の最初の文字のインデックス。部分文字列がない場合は -1。

例外:

NullPointerException - str が null である場合。

導入されたバージョン:

1.4

indexOf

public int indexOf(String str,
          int fromIndex)

指定されたインデックス以降で、指定された部分文字列がこの文字列内で最初に出現する位置のインデックスを返します。返される整数は、次の式が true となるような最小値 k になります。

     k >= Math.min(fromIndex, str.length()) &&
                   this.toString().startsWith(str, k)
 

このような k の値が存在しない場合、-1 が返されます。

パラメータ:

str - 検索対象の部分文字列。

fromIndex -検索開始位置のインデックス。

戻り値:

指定されたインデックスから検索を開始して、最初に指定された部分文字列が出現する、この文字列内のインデックス。

例外:

NullPointerException - str が null である場合。

導入されたバージョン:

1.4

lastIndexOf

public int lastIndexOf(String str)

この文字列内で、指定された部分文字列が一番右に出現する位置のインデックスを返します。空の文字列「」の一番右に出現した位置が、this.length() と見なされます。返されるインデックスは、次を満たす最大値 k になります。

 this.toString().startsWith(str, k)
 

が true である。

パラメータ:

str - 検索対象の部分文字列。

戻り値:

文字列引数がこのオブジェクト内の部分文字列として 1 回以上出現する場合は、該当する最後の部分文字列の最初の文字のインデックス。部分文字列として出現しない場合は、-1。

例外:

NullPointerException - str が null である場合。

導入されたバージョン:

1.4

lastIndexOf

public int lastIndexOf(String str,
              int fromIndex)

この文字列内で、指定された部分文字列が最後に出現する位置のインデックスを返します。返される整数は、次を満たす最大値 k になります。

     k <= Math.min(fromIndex, str.length()) &&
                   this.toString().startsWith(str, k)
 

このような k の値が存在しない場合、-1 が返されます。

パラメータ:

str - 検索対象の部分文字列。

fromIndex - 検索開始位置のインデックス。

戻り値:

このシーケンス内で、指定された部分文字列が最後に出現する位置のインデックス。

例外:

NullPointerException - str が null である場合。

導入されたバージョン:

1.4

reverse

public StringBuffer reverse()

この文字シーケンスを、シーケンスの順序を逆にしたもので置き換えます。シーケンスにサロゲートペアが含まれている場合、それらは反転操作時に単一の文字として扱われます。したがって、サロゲートの上位-下位の順番が反転することは決してありません。 reverse メソッドの実行直前に、この文字シーケンスの文字長 (char 値での長さではない) が n であったとします。このとき、新しい文字シーケンス内のインデックス k の文字は、以前の文字シーケンス内のインデックス n-k-1 の文字と等しくなります。

反転操作を行うと、操作前にはペアになっていなかった下位サロゲートと上位サロゲートからサロゲートペアが生成される可能性があります。たとえば、「\uDC00\uD800」を反転すると「\uD800\uDC00」が生成されますが、これは有効なサロゲートペアです。

戻り値:

このオブジェクトへの参照。

導入されたバージョン:

JDK1.0.2

toString

public String toString()

このシーケンス内のデータを表す文字列を返します。新しい String オブジェクトが割り当てられ、現在このオブジェクトで表されている文字シーケンスを含むように初期化されます。その後、この String が返されます。その後このシーケンスが変更されても、String の内容には影響ありません。

定義:

toString、インタフェース: CharSequence

戻り値:

この文字シーケンスの文字列表現。