java.lang
クラス String

java.lang.Object
  java.lang.String

public final class String
extends Object

String クラスは文字列を表します。

String オブジェクトが保持する文字列は、オブジェクトが生成された後は変更できません。

String はUTF-16形式の文字列を表します。 補助キャラクタはこの形式ではサロゲートペアで表現されるため、文字列中では2文字を占めます。

コンストラクタの概要

String()
長さ 0 の、空の文字列を表す String オブジェクトを生成します。

String(byte[] bytes)
指定されたバイト列を Modified UTF-8 でエンコードされたバイト列とみなして復号した文字列を保持する String を生成します。

String(byte[] bytes, int offset, int count)
指定されたバイト配列 bytes の、オフセット offset から格納されている長さ count のバイト列を、 Modified UTF-8 でエンコードされたバイト列とみなして復号した文字列を保持する String を生成します。

String(char[] value)
指定された char 配列に格納されている文字列を表す String を生成します。

String(char[] value, int offset, int count)
指定された char 配列 value の、オフセット offset から格納されている長さ count の文字列を表す String を生成します。

String(String string)
指定された String が表す文字列と同じ文字列を表す String を生成します。

String(StringBuffer sb)
指定された StringBuffer に格納されている文字列を表す String を生成します。

メソッドの概要

char	charAt(int index) 指定されたインデックスにある文字を返します。
int	compareTo(String anotherString) 指定された String とこの String を比較します。
String	concat(String str) 指定された文字列をこのオブジェクトの文字列の後に連結した文字列を表す String オブジェクトを返します。
boolean	endsWith(String suffix) この String が指定された文字列で終了しているかどうか判定します。
boolean	equals(Object anObject) 指定されたオブジェクトとこのオブジェクトを比較します。
boolean	equalsIgnoreCase(String name) 指定された String とこの String を大文字小文字を区別しないで比較します。
byte[]	getBytes() この String を Modified UTF-8 でエンコードした結果をバイト配列に格納して返します。
void	getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin) この String の文字列を指定された char 配列にコピーします。
int	hashCode() この String のハッシュ値を返します。
int	indexOf(int c) 指定された文字 c がこの String の文字列で最初に出現する位置を返します。
int	indexOf(int ch, int fromIndex) 指定された文字 ch がこの String の文字列のインデックス fromIndex 以降で最初に出現する位置を返します。
int	indexOf(String string) 指定された文字列 string がこの String のなかで最初に出現する位置を返します。
int	indexOf(String string, int index) 指定された文字列 string がこの String の文字列のインデックス index 以降で最初に出現する位置を返します。
int	lastIndexOf(int c) 指定された文字 c がこの String の文字列で最後に出現する位置を返します。
int	lastIndexOf(int c, int i) 指定された文字 c がこの String の文字列のインデックス i 以前で最後に出現する位置を返します。
int	length() この String オブジェクトが表す文字列の長さを返します。
boolean	regionMatches(boolean type, int moffset, String target, int toffset, int len) 指定された String と、この String の指定された領域を比較します。
String	replace(char src, char dst) この String の文字列中に存在する文字 src のすべてを文字 dst に置き換えた文字列を表す String を生成して返します。
boolean	startsWith(String prefix) この String が指定された文字列で始まっているかどうかを判定します。
boolean	startsWith(String prefix, int toffset) この String のインデックス toffset からの文字列が指定された文字列 prefix で始まっているかどうかを判定します。
String	substring(int beginIndex) この String のインデックス beginIndex から最後の文字までの部分文字列を表す String を生成して返します。
String	substring(int beginIndex, int endIndex) この String のインデックス beginIndex から endIndex-1 までの部分文字列を表す String を生成して返します。
char[]	toCharArray() この String の文字列と等しい文字シーケンスで初期化された char 配列を生成して返します。
String	toLowerCase() このオブジェクトの文字列の個々の文字を Character.toLowerCase メソッドで小文字に変換した文字列を表す String を生成して返します。
String	toString() このオブジェクトを返します。
String	toUpperCase() このオブジェクトの文字列の個々の文字を Character.toUpperCase メソッドで大文字に変換した文字列を表す String を生成して返します。
String	trim() この String の文字列の前後の空白文字を削除した文字列を表す String を生成して返します。
static String	valueOf(boolean b) 指定された boolean 値を表す String オブジェクトを返します。
static String	valueOf(char c) 指定された char 値を表す String オブジェクトを返します。
static String	valueOf(char[] carr) 指定された char 配列の文字列を表す String オブジェクトを返します。
static String	valueOf(char[] data, int offset, int count) 指定された char 配列の、オフセット offset から格納されている文字数 count の文字列を表す String オブジェクトを返します。
static String	valueOf(int i) 指定された int 値を表す String オブジェクトを返します。
static String	valueOf(long l) 指定された long 値を表す String オブジェクトを返します。
static String	valueOf(Object o) 指定されたオブジェクトの文字列表現を返します。

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

getClass, notify, notifyAll, wait, wait

コンストラクタの詳細

String

public String()

長さ 0 の、空の文字列を表す String オブジェクトを生成します。

String

public String(String string)

指定された String が表す文字列と同じ文字列を表す String を生成します。 このメソッドは string の文字列を内部にコピーします。 String は不変（immutable）であるため、明示的にコピーが必用な場合を除いて、このコンストラクタを使う必要はありません。

パラメータ:

string - 参照する文字列

String

public String(byte[] bytes)

指定されたバイト列を Modified UTF-8 でエンコードされたバイト列とみなして復号した文字列を保持する String を生成します。 復号結果の文字列の長さは、 bytes.length と必ずしも一致しません。

パラメータ:

bytes - 文字列に復号する、Modified UTF-8 でエンコードされたバイト列

String

public String(byte[] bytes,
              int offset,
              int count)

指定されたバイト配列 bytes の、オフセット offset から格納されている長さ count のバイト列を、 Modified UTF-8 でエンコードされたバイト列とみなして復号した文字列を保持する String を生成します。 復号結果の文字列の長さは、 count と必ずしも一致しません。

パラメータ:

bytes - 文字シーケンスを格納しているバイト配列

offset - 復号するバイト列の先頭を示す配列インデックス

count - 復号するバイト列のバイト長

例外:

IndexOutOfBoundsException - offset と count が示す領域が配列 bytes 内の境界を超える場合

String

public String(char[] value)

指定された char 配列に格納されている文字列を表す String を生成します。 value に格納されている文字列は String 内部にコピーされます。

パラメータ:

value - 文字列を保持している配列

String

public String(StringBuffer sb)

指定された StringBuffer に格納されている文字列を表す String を生成します。 StringBuffer に格納されている文字列は String 内部にコピーされます。

パラメータ:

sb - 文字列を保持している StringBuffer

String

public String(char[] value,
              int offset,
              int count)

指定された char 配列 value の、オフセット offset から格納されている長さ count の文字列を表す String を生成します。 value に格納されている文字列は String 内部にコピーされます。

パラメータ:

value - 文字シーケンスを格納している char 配列

offset - char 列の先頭を示す配列インデックス

count - char 列の長さ（文字数）

例外:

IndexOutOfBoundsException - offset と count が示す領域が配列valueの境界を超える場合

メソッドの詳細

equals

public boolean equals(Object anObject)

指定されたオブジェクトとこのオブジェクトを比較します。

anObject が null ではなく、 anObject がこの String オブジェクトと同一の文字列を表す String オブジェクトの場合、このメソッドは true を返します。そうでなければ false を返します

オーバーライド:

クラス Object 内の equals

パラメータ:

anObject - 比較対象のオブジェクト

戻り値:

anObject が同じ文字列を表す String である場合 true、そうでなければ false 。

charAt

public char charAt(int index)

指定されたインデックスにある文字を返します。 インデックスは、先頭の文字を 0 として最後の文字 length() - 1 までの値です。

指定されたインデックスの文字がサロゲートペアのどちらかであった場合、その文字の char 値がそのまま返されます。

パラメータ:

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

戻り値:

指定されたインデックスにある char 値

例外:

IndexOutOfBoundsException - 0 <= index <= length()-1 でない場合

length

public int length()

この String オブジェクトが表す文字列の長さを返します。 この値は文字列中の16ビットユニコード文字の個数に一致します。

戻り値:

この String オブジェクトが表す文字列の長さ

compareTo

public int compareTo(String anotherString)

指定された String とこの String を比較します。

比較は、それぞれの String のユニコード値に基づいて行われます。

もしこの String オブジェクトが anotherString より辞書的に前方にある場合、負の値が返されます。 後方にある場合は正の値が返されます。 一致する場合は0が返されます。

0ではない、正または負の値が返される場合、次のうちのどれかまたは両方を意味します。

• 二つの文字列において、文字列の中を示す有効な同じインデックスが指す位置に異なる文字がある。
• 二つの文字列の長さが異なる。

一か所以上のインデックス位置において異なる文字がある場合、そのようなインデックスのうちの最小のインデックス値を k とすると、このメソッドはそれらの文字の値の差を返します。 この差分値は以下の式で表されます。

this.charAt(k)-anotherString.charAt(k)

もし両方の文字列に文字が存在するインデックスにおいて、文字の値に差がない場合、このメソッドは文字列の長さの差を返します。 この差分値は以下の式で表されます。

this.length()-anotherString.length()

このメソッドが0を返す場合, equals(anotherString) は true を返します。

パラメータ:

anotherString - 比較する String

戻り値:

• 0: 二つの String が等しい場合
• 負の値: この String オブジェクトが辞書的に anotherString の前方にある場合
• 正の値: この String オブジェクトが辞書的に anotherString の後方にある場合

concat

public String concat(String str)

指定された文字列をこのオブジェクトの文字列の後に連結した文字列を表す String オブジェクトを返します。 str の長さが 0 の場合、このメソッドは自オブジェクトを返します。 それ以外では、このメソッドは連結した文字列で String オブジェクトを生成して返します。

パラメータ:

str - この String オブジェクトの文字列の後ろに連結する文字列

戻り値:

この String オブジェクトの文字列の後に str の文字列を連結した文字列を表す String オブジェクト

getBytes

public byte[] getBytes()

この String を Modified UTF-8 でエンコードした結果をバイト配列に格納して返します。

戻り値:

エンコード結果のバイト列

getChars

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

この String の文字列を指定された char 配列にコピーします。

各パラメータに明らかに異常な値を指定した場合の振る舞いは保証されません。

パラメータ:

srcBegin - コピー元先頭位置を示すインデックス

srcEnd - コピー元終了位置の次を示すインデックス

dst - コピー先の配列

dstBegin - コピー先先頭位置を示すインデックス

例外:

IndexOutOfBoundsException - 以下のどれかの場合

• srcEnd < srcBegin
• this.length() < srcBegin
• dstBegin < 0
• dst.length < dstBegin

substring

public String substring(int beginIndex)

この String のインデックス beginIndex から最後の文字までの部分文字列を表す String を生成して返します。

パラメータ:

beginIndex - 部分文字列の先頭を示すインデックス

戻り値:

指定された部分文字列を表す String

例外:

IndexOutOfBoundsException - beginIndex が負の場合、またはこの String オブジェクトの長さより大きい場合

substring

public String substring(int beginIndex,
                        int endIndex)

この String のインデックス beginIndex から endIndex-1 までの部分文字列を表す String を生成して返します。

パラメータ:

beginIndex - 部分文字列の先頭を示すインデックス

endIndex - 部分文字列の最後の文字の次を示すインデックス このインデックスが指す文字は部分文字列に含まれません。

戻り値:

指定された部分文字列を表す String

例外:

IndexOutOfBoundsException - 以下のどれかの場合

• beginIndex < 0
• endIndex < beginIndex
• this.length() < endIndex

startsWith

public boolean startsWith(String prefix)

この String が指定された文字列で始まっているかどうかを判定します。

パラメータ:

prefix - 比較する文字列

戻り値:

この String が prefix の文字列で始まっている場合 true 、そうでなければ false を返します。 prefix.length == 0 の場合や、 this.equals(prefix) が true の場合も true を返します。

startsWith

public boolean startsWith(String prefix,
                          int toffset)

この String のインデックス toffset からの文字列が指定された文字列 prefix で始まっているかどうかを判定します。

パラメータ:

prefix - 比較する文字列

toffset - この String 内の、比較する文字列の先頭を指すインデックス

戻り値:

この String のインデックス toffset からの文字列が prefix の文字列で始まっている場合 true 、そうでなければ false を返します。 toffset が負の場合、またはこの String の長さより大きい場合 false を返します。 そうでない場合、戻り値は以下の結果と同じ値になります。

this.substring(toffset).startsWith(prefix)

trim

public String trim()

この String の文字列の前後の空白文字を削除した文字列を表す String を生成して返します。

この String が空文字列を表す場合、およびこの String の文字列の先頭文字と最後の文字が非空白文字（ '\u0020' より大きな値の文字）の場合、このメソッドはこの String オブジェクト自身を返します。

この String の全ての文字が空白文字（ '\u0020' 以下の値の文字）である場合、このメソッドは空文字列を表す String を生成して返します。

これら以外の場合、このメソッドは、この String で最初に出現する非空白文字から最後の非空白文字までの文字列を表す String を生成して返します。

戻り値:

この String の文字列の前後の空白文字を削除した文字列を表す String 。前後の空白文字がない場合はこの String オブジェクト自身。

valueOf

public static String valueOf(Object o)

指定されたオブジェクトの文字列表現を返します。

パラメータ:

o - 任意のオブジェクト

戻り値:

o が null の場合 "null" を表す String 、それ以外は o.toString() の結果を返します。

toString

public String toString()

このオブジェクトを返します。

オーバーライド:

クラス Object 内の toString

戻り値:

自オブジェクト

valueOf

public static String valueOf(boolean b)

指定された boolean 値を表す String オブジェクトを返します。

パラメータ:

b - boolean 値

戻り値:

b が true の場合、 "true" を表す String オブジェクトが生成されて返ります。 false の場合、 "false" を表す String オブジェクトが生成されて返ります。

valueOf

public static String valueOf(int i)

指定された int 値を表す String オブジェクトを返します。

パラメータ:

i - 任意の int 値

戻り値:

Integer.toString(i) の戻り値が返ります。

valueOf

public static String valueOf(long l)

指定された long 値を表す String オブジェクトを返します。

パラメータ:

l - 任意の long 値

戻り値:

Long.toString(l) の戻り値が返ります。

valueOf

public static String valueOf(char c)

指定された char 値を表す String オブジェクトを返します。

パラメータ:

c - 任意の char 値

戻り値:

指定された文字だけからなる文字列を表す String オブジェクトが生成されて返ります。

valueOf

public static String valueOf(char[] carr)

指定された char 配列の文字列を表す String オブジェクトを返します。 carr の文字列は新たに生成される String オブジェクトの内部にコピーされます。

パラメータ:

carr - char 配列

戻り値:

carr に指定された文字列を表す String オブジェクトが生成されて返ります。

valueOf

public static String valueOf(char[] data,
                             int offset,
                             int count)

指定された char 配列の、オフセット offset から格納されている文字数 count の文字列を表す String オブジェクトを返します。 data の文字列は新たに生成される String オブジェクトの内部にコピーされます。

パラメータ:

data - char 配列

offset - data 内の部分文字列の先頭を指すインデックス

count - 部分文字列の文字数

戻り値:

指定された文字列を表す String オブジェクトを生成して返します。 このメソッドは new String(data, offset, count) を return します。

例外:

IndexOutOfBoundsException - offset と count が示す領域が配列 data の境界を超える場合

toUpperCase

public String toUpperCase()

このオブジェクトの文字列の個々の文字を Character.toUpperCase メソッドで大文字に変換した文字列を表す String を生成して返します。 ただし、全ての文字について大文字に変換されなかった場合、このメソッドは自オブジェクトを返します。

戻り値:

大文字に変換された文字列を表す String オブジェクト

toLowerCase

public String toLowerCase()

このオブジェクトの文字列の個々の文字を Character.toLowerCase メソッドで小文字に変換した文字列を表す String を生成して返します。 ただし、全ての文字について小文字に変換されなかった場合、このメソッドは自オブジェクトを返します。

戻り値:

小文字に変換された文字列を表す String オブジェクト

indexOf

public int indexOf(String string)

指定された文字列 string がこの String のなかで最初に出現する位置を返します。

パラメータ:

string - 任意の文字列

戻り値:

string がこの String オブジェクトの部分文字列として最初に出現する位置を、その先頭の文字を示すインデックス値で返します。ひとつも出現しない場合は -1 を返します。

indexOf

public int indexOf(String string,
                   int index)

指定された文字列 string がこの String の文字列のインデックス index 以降で最初に出現する位置を返します。 index に負の値が指定された場合、0が指定された場合と同じ処理が行われます。

パラメータ:

string - 任意の文字列

index - この String オブジェクトの文字列中で検索を開始する位置を示すインデックス

戻り値:

string がこの String オブジェクトの文字列のインデックス index 以降の部分文字列として最初に出現する位置を、その先頭の文字を示すインデックス値で返します。ひとつも出現しない場合は -1 を返します。

indexOf

public int indexOf(int ch,
                   int fromIndex)

指定された文字 ch がこの String の文字列のインデックス fromIndex 以降で最初に出現する位置を返します。 fromIndex に負の値が指定された場合、0が指定された場合と同じ処理が行われます。 this.length() 以上の値が指定された場合、-1が返ります。

パラメータ:

ch - 任意の文字

fromIndex - この String オブジェクトの文字列中で検索を開始する位置を示すインデックス。

戻り値:

ch がこの String オブジェクトの文字列のインデックス fromIndex 以降に最初に出現する位置を、そのインデックス値で返します。ひとつも出現しない場合は -1 を返します。

indexOf

public int indexOf(int c)

指定された文字 c がこの String の文字列で最初に出現する位置を返します。

パラメータ:

c - 任意の文字

戻り値:

c がこの String オブジェクトの文字列に最初に出現する位置を、そのインデックス値で返します。ひとつも出現しない場合は -1 を返します。

lastIndexOf

public int lastIndexOf(int c)

指定された文字 c がこの String の文字列で最後に出現する位置を返します。

パラメータ:

c - 任意の文字

戻り値:

c がこの String オブジェクトの文字列で最後に出現する位置を、そのインデックス値で返します。ひとつも出現しない場合は -1 を返します。

lastIndexOf

public int lastIndexOf(int c,
                       int i)

指定された文字 c がこの String の文字列のインデックス i 以前で最後に出現する位置を返します。 i に this.length() 以上の値が指定された場合、 this.length()-1 が指定された場合と同じ処理が行われます。 負の値が指定された場合、-1が返ります。

パラメータ:

c - 任意の文字

i - この String オブジェクトの文字列中で検索を先頭に向かって開始する位置を示すインデックス。

戻り値:

c がこの String オブジェクトの文字列のインデックス i 以前で最後に出現する位置を、そのインデックス値で返します。ひとつも出現しない場合は -1 を返します。

endsWith

public boolean endsWith(String suffix)

この String が指定された文字列で終了しているかどうか判定します。

パラメータ:

suffix - 比較する文字列

戻り値:

この String の文字列が suffix の文字列で終了している場合 true を返します。 それ以外は false を返します。 suffix の文字列が空文字列である場合や、 suffix.equals(this) が true である場合にもこのメソッドは true を返すことに注意してください。

equalsIgnoreCase

public boolean equalsIgnoreCase(String name)

指定された String とこの String を大文字小文字を区別しないで比較します。 二つの文字列は、それぞれの長さが等しく、かつ対応する文字が大文字小文字を区別しないで等しい場合に、大文字小文字を区別しないで等しいとみなされます。

二つの char c1 と c2 が大文字小文字を区別しないで等しいとみなす条件は、次のどれかが成立することです。

• ch == c2
• Character.toUpperCase(c1) == Character.toUpperCase(c2)
• Character.toLowerCase(c1) == Character.toLowerCase(c2)

パラメータ:

name - 比較する文字列

戻り値:

比較結果。大文字小文字の区別をしないで等しいとみなされる場合は true 、そうでなければ false が返ります。

replace

public String replace(char src,
                      char dst)

この String の文字列中に存在する文字 src のすべてを文字 dst に置き換えた文字列を表す String を生成して返します。

この String の文字列中に src が出現しない場合はこの String オブジェクト自身を返します。

パラメータ:

src - 置き換えの対象となる文字

dst - 置き換えた結果とする文字

戻り値:

src を dst に置き換えた結果の文字列を表す String

regionMatches

public boolean regionMatches(boolean type,
                             int moffset,
                             String target,
                             int toffset,
                             int len)

指定された String と、この String の指定された領域を比較します。 target のインデックス toffset から始まる len 文字の文字列と、この String オブジェクトのインデックス moffset から始まる文字列を比較します。 type が true の場合、大文字小文字を区別しないで比較します。 等しいと判定した場合 true 、等しくないと判定した場合は false を返します。

以下のどれかの条件が成立する場合、 false が返ります

• moffset < 0
• toffset < 0
• (moffset + len) > this.length()
• (toffset + len) > target.length()
• type が false で、指定された領域の文字同士で異なる文字がある。
• type が true で、指定された領域の文字同士で、 Character.toLowerCase メソッドが返す値が等しくない文字がある。

パラメータ:

type - 大文字小文字の区別。 true の場合、大文字小文字を区別しません。 false の場合、大文字小文字を区別します。

moffset - この String 中の、比較の対象とする部分文字列のオフセット

target - 比較する String

toffset - target 中の、比較の対象とする部分文字列のオフセット

len - 比較の対象とする部分文字列の文字数。 len <= 0 の場合の振る舞いは保証されません。

戻り値:

比較の結果、文字列同士が等しいと判定した場合 true 、そうでない場合は false

hashCode

public int hashCode()

この String のハッシュ値を返します。 この String のインデックス i の文字を s[i] として、 n を String の文字数とすると、ハッシュ値は以下の演算によって求めます。

s[0]*31^(n-1) + s[1]*31^(n-2) + ... + s[n-1]

ここで ^ はべき乗を表します。

オーバーライド:

クラス Object 内の hashCode

戻り値:

この String のハッシュ値。

toCharArray

public char[] toCharArray()

この String の文字列と等しい文字シーケンスで初期化された char 配列を生成して返します。

戻り値:

この String と同じ文字列を保持する char 配列