String クラス

署名

public String abbreviate(Integer maxWidth)

パラメーター

maxWidth

型: Integer

maxWidth が 4 未満の場合、このメソッドは実行時例外を発生させます。

戻り値

型: String

例

1String s = 'Hello Maximillian';
2String s2 = s.abbreviate(8);
3System.assertEquals('Hello...', s2);
4System.assertEquals(8, s2.length());

署名

public String abbreviate(Integer maxWidth, Integer offset)

パラメーター

maxWidth

型: Integer

オフセットは、返される string の左端の文字または省略記号に続く最初の文字であるとは限りませんが、結果のどこかに表示されます。これらに関係なく、abbreviate は maxWidth を超える長さの string は返しません。maxWidth が小さすぎる場合、このメソッドは実行時例外を発生させます。

offset

型: Integer

戻り値

型: String

例

1String s = 'Hello Maximillian';
2// Start at M
3String s2 = s.abbreviate(9,6);
4System.assertEquals('...Max...', s2);
5System.assertEquals(9, s2.length());

署名

public String capitalize()

戻り値

型: String

使用方法

このメソッドは、Character.toTitleCase(char) Java メソッドに基づいてます。

例

1String s = 'hello maximillian';
2String s2 = s.capitalize();
3System.assertEquals('Hello maximillian', s2);

署名

public String center(Integer size)

パラメーター

size

型: Integer

戻り値

型: String

例

1String s = 'hello';
2String s2 = s.center(9);
3System.assertEquals(
4   '  hello  ',
5   s2);

署名

public String center(Integer size, String paddingString)

パラメーター

size

型: Integer

paddingString

型: String

戻り値

型: String

例

1String s = 'hello';
2String s2 = s.center(9, '-');
3System.assertEquals('--hello--', s2);

署名

public Integer charAt(Integer index)

パラメーター

index

型: Integer

値を取得する文字のインデックス。

戻り値

型: Integer

文字の整数値。

使用方法

charAt メソッドは、指定されたインデックスで参照される文字の値を返します。インデックスがサロゲートペアの先頭 (上位サロゲートコードポイント) を参照している場合、このメソッドは上位サロゲートコードポイントのみを返します。サロゲートペアに対応する補助コードポイントを返すには、代わりに codePointAt をコールします。

例

次の例では、インデックス 0 にある最初の文字の値を取得します。

1String str = 'Ω is Omega.';
2System.assertEquals(937, str.charAt(0));

次の例では charAt と codePointAt の違いを示します。この例では、これらのメソッドをエスケープされた補助 Unicode 文字に対してコールします。charAt(0) は、上位サロゲート値 (\uD835 に対応) を返します。codePointAt(0) は、サロゲートペア全体の値を返します。

1String str = '\uD835\uDD0A';
2System.assertEquals(55349, str.charAt(0), 
3    'charAt(0) didn\'t return the high surrogate.');
4System.assertEquals(120074, str.codePointAt(0),
5    'codePointAt(0) didn\'t return the entire two-character supplementary value.');

署名

public Integer codePointAt(Integer index)

パラメーター

index

型: Integer

文字列に含まれる文字 (Unicode コードユニット) のインデックス。インデックス範囲は 0 ～ (文字列長 - 1) です。

戻り値

型: Integer

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

使用方法

index がサロゲートペアの先頭 (上位サロゲートコードポイント) を参照していて、その次のインデックスの文字値が下位サロゲートコードポイントを参照している場合、このメソッドはサロゲートペアに対応する補助コードポイントを返します。それ以外の場合、このメソッドは所定のインデックスにある文字値を返します。

Unicode とサロゲートペアについての詳細は、「ユニコードコンソーシアム」を参照してください。

例

次の例では、インデックス 0 にある最初の文字のコードポイント値を取得します。この場合は、エスケープされたオメガ (Ω) 文字です。また、この例ではインデックス 20 のコードポイントも取得します。これはエスケープされた補助 Unicode 文字 (文字のペア) に対応します。さらに、オメガのエスケープされた形式とエスケープされていない形式のコードポイント値が同じであることを検証します。

この例の補助文字 (\\uD835\\uDD0A) は、次の数学用フラクトゥール大文字 G に対応します。

1String str = '\u03A9 is Ω (Omega), and \uD835\uDD0A ' + 
2    ' is Fraktur Capital G.';
3System.assertEquals(937, str.codePointAt(0));
4System.assertEquals(120074, str.codePointAt(20));
5// Escaped or unescaped forms of the same character have the same code point
6System.assertEquals(str.codePointAt(0), str.codePointAt(5));

署名

public Integer codePointBefore(Integer index)

パラメーター

index

型: Integer

返される Unicode コードポイントの前のインデックス。インデックス範囲は 1 ～文字列長です。

戻り値

型: Integer

指定されたインデックスより前に出現する文字または Unicode コードポイント値。

使用方法

index-1 の文字値が下位サロゲートコードポイントで、index-2 が負ではなく、このインデックス位置にある文字が上位サロゲートコードポイントである場合、このメソッドはこのサロゲートペアに対応する補助コードポイントを返します。index-1 の文字値がペアになっていない下位サロゲートまたは上位サロゲートコードポイントである場合、そのサロゲート値が返されます。

Unicode とサロゲートペアについての詳細は、「ユニコードコンソーシアム」を参照してください。

例

次の例では、最初の文字 (インデックス 1 の前) のコードポイント値を取得します。この場合は、エスケープされたオメガ (Ω) 文字です。また、この例ではインデックス 20 のコードポイントも取得します。これはエスケープされた補助文字 (インデックス 22 の前の 2 文字) に対応します。

1String str = '\u03A9 is Ω (Omega), and \uD835\uDD0A ' + 
2    ' is Fraktur Capital G.';
3System.assertEquals(937, str.codePointBefore(1));
4System.assertEquals(120074, str.codePointBefore(22));

署名

public Integer codePointCount(Integer beginIndex, Integer endIndex)

パラメーター

beginIndex

型: Integer

範囲内の最初の文字のインデックス。

endIndex

型: Integer

範囲内の最後の文字の次のインデックス。

戻り値

型: Integer

指定された範囲内にある Unicode コードポイントの数。

使用方法

指定された範囲は beginIndex で開始し、endIndex—1 で終了します。テキスト範囲内のペアになっていないサロゲートは、それぞれ 1 つのコードポイントと見なされます。

例

次の例では、エスケープされた Unicode 文字が含まれるサブ文字列と、1 つのコードポイントと見なされる複数の Unicode 補助文字が含まれる別のサブ文字列内のコードポイントの件数を出力します。

1String str = '\u03A9 and \uD835\uDD0A characters.';
2System.debug('Count of code points for ' + str.substring(0,1) 
3             + ': ' + str.codePointCount(0,1));
4System.debug('Count of code points for ' + str.substring(6,8) 
5             + ': ' + str.codePointCount(6,8));
6
7// Output:
8// Count of code points for Ω: 1
9// Count of code points for : 1

署名

public Integer compareTo(String secondString)

パラメーター

secondString

型: String

戻り値

型: Integer

使用方法

結果は次のとおりです。

• メソッドをコールした string が辞書編集的に secondString の前に来る場合は負の Integer
• メソッドをコールした string が辞書編集的に compsecondStringString の後に来る場合は正の Integer
• string が等しい場合は 0

string が異なるインデックス位置がない場合、辞書編集的に短い string が長い string の後になります。

equals メソッドが true を返す場合、このメソッドは 0 を返します。

例

1String myString1 = 'abcde';
2String myString2 = 'abcd';
3Integer result = 
4   myString1.compareTo(myString2);
5System.assertEquals(result, 1);

署名

public Boolean contains(String substring)

パラメーター

substring

型: String

戻り値

型: Boolean

例

1String myString1 = 'abcde';
2String myString2 = 'abcd';
3Boolean result = 
4   myString1.contains(myString2);
5System.assertEquals(result, true);

署名

public Boolean containsAny(String inputString)

パラメーター

inputString

型: String

戻り値

型: Boolean

例

1String s = 'hello';
2Boolean b1 = s.containsAny('hx');
3Boolean b2 = s.containsAny('x');
4System.assertEquals(true, b1);
5System.assertEquals(false, b2);

署名

public Boolean containsIgnoreCase(String substring)

パラメーター

substring

型: String

戻り値

型: Boolean

例

1String s = 'hello';
2Boolean b = s.containsIgnoreCase('HE');
3System.assertEquals(
4   true,
5   b);

署名

public Boolean containsNone(String inputString)

パラメーター

inputString

型: String

inputString が空の文字列の場合または現在の string が空の場合、このメソッドは true を返します。inputString が null の場合、このメソッドは実行時例外を返します。

戻り値

型: Boolean

例

1String s1 = 'abcde';
2System.assert(s1.containsNone('fg'));

署名

public Boolean containsOnly(String inputString)

パラメーター

inputString

型: String

戻り値

型: Boolean

例

1String s1 = 'abba';
2String s2 = 'abba xyz';
3Boolean b1 = 
4   s1.containsOnly('abcd');
5System.assertEquals(
6   true,
7   b1);
8Boolean b2 = 
9   s2.containsOnly('abcd');
10System.assertEquals(
11   false,
12   b2);

署名

public Boolean containsWhitespace()

戻り値

型: Boolean

例

1String s = 'Hello Jane';
2System.assert(s.containsWhitespace()); //true
3s = 'HelloJane ';
4System.assert(s.containsWhitespace()); //true
5s = ' HelloJane';
6System.assert(s.containsWhitespace()); //true
7s = 'HelloJane';
8System.assert(!s.containsWhitespace()); //false

署名

public Integer countMatches(String substring)

パラメーター

substring

型: String

戻り値

型: Integer

例

1String s = 'Hello Jane';
2System.assertEquals(1, s.countMatches('Hello'));
3s = 'Hello Hello';
4System.assertEquals(2, s.countMatches('Hello'));
5s = 'Hello hello';
6System.assertEquals(1, s.countMatches('Hello'));

署名

public String deleteWhitespace()

戻り値

型: String

例

1String s1 = ' Hello Jane ';
2String s2 = 'HelloJane';
3System.assertEquals(s2, s1.deleteWhitespace());

署名

public String difference(String secondString)

パラメーター

secondString

型: String

secondString が空の文字列の場合、このメソッドは空の文字列を返します。secondString が null の場合、このメソッドは実行時例外を発生させます。

戻り値

型: String

例

1String s = 'Hello Jane';
2String d1 = 
3   s.difference('Hello Max');
4System.assertEquals(
5   'Max',
6   d1);
7String d2 = 
8   s.difference('Goodbye');
9System.assertEquals(
10   'Goodbye',
11   d2);

署名

public Boolean endsWith(String suffix)

パラメーター

suffix

型: String

戻り値

型: Boolean

例

1String s = 'Hello Jason';
2System.assert(s.endsWith('Jason'));

署名

public Boolean endsWithIgnoreCase(String suffix)

パラメーター

suffix

型: String

戻り値

型: Boolean

例

1String s = 'Hello Jason';
2System.assert(s.endsWithIgnoreCase('jason'));

署名

public Boolean equals(String secondString)

パラメーター

secondString

型: String

戻り値

型: Boolean

使用方法

compareTo メソッドが 0 を返す場合、このメソッドは true を返します。

このメソッドを使用して、大文字と小文字を区別する比較を実行します。他方、== 演算子は、Apex セマンティックを一致させるために大文字と小文字を区別しない比較を実行します。

例

1String myString1 = 'abcde';
2String myString2 = 'abcd';
3Boolean result = myString1.equals(myString2);
4System.assertEquals(result, false);

署名

public Boolean equals(Object stringOrId)

パラメーター

stringOrId

型: Object

戻り値

型: Boolean

使用方法

ID 値を比較する場合、ID の長さが同じである必要はありません。たとえば、15 文字の ID 文字列を同等の 18 文字の ID 値を表すオブジェクトと比較した場合、このメソッドは true を返します。15 文字と 18 文字の ID についての詳細は、「ID データ型」を参照してください。

このメソッドを使用して、大文字と小文字を区別する比較を実行します。他方、== 演算子は、Apex セマンティックを一致させるために大文字と小文字を区別しない比較を実行します。

例

次の例は、さまざまな種別の変数を比較して、値が等価であった場合と等価ではなかった場合の両方を示しています。また、Apex によって比較される前に、特定の値がどのように自動変換されるかも示しています。

1// Compare a string to an object containing a string
2Object obj1 = 'abc';
3String str = 'abc';
4Boolean result1 = str.equals(obj1);
5System.assertEquals(true, result1);
6
7// Compare a string to an object containing a number
8Integer obj2 = 100;
9Boolean result2 = str.equals(obj2);
10System.assertEquals(false, result2);
11
12// Compare a string to an ID of the same length.
13// 15-character ID
14Id idValue15 = '001D000000Ju1zH';
15// 15-character ID string value
16String stringValue15 = '001D000000Ju1zH';
17Boolean result3 = stringValue15.equals(IdValue15);
18System.assertEquals(true, result3); 
19
20// Compare two equal ID values of different lengths:
21//  15-character ID and 18-character ID
22Id idValue18 = '001D000000Ju1zHIAR';
23Boolean result4 = stringValue15.equals(IdValue18);
24System.assertEquals(true, result4);

署名

public Boolean equalsIgnoreCase(String secondString)

パラメーター

secondString

型: String

戻り値

型: Boolean

使用方法

String.equalsIgnoreCase() メソッドは、コンテキストユーザーのロケールを無視します。ロケールに従って文字列を比較したい場合は、代わりに == 演算子を使用します。String.equalsIgnoreCase() メソッドはロケールを無視するため、通常はこの演算子よりも高速に実行されます。

例

1String myString1 = 'abcd';
2String myString2 = 'ABCD';
3Boolean result = 
4myString1.equalsIgnoreCase(myString2);
5System.assertEquals(result, true);

署名

public String escapeCsv()

戻り値

型: String

使用方法

string にカンマ、改行、または二重引用符が含まれる場合、返される string は二重引用符で囲まれます。また、文字列内のすべての二重引用符はさらにもう 1 つの二重引用符でエスケープされます。

string にカンマ、改行、二重引用符が含まれない場合、string が変更されずに返されます。

例

1String s1 = 'Max1, "Max2"';
2String s2 = s1.escapeCsv();
3System.assertEquals('"Max1, ""Max2"""', s2);

署名

public String escapeEcmaScript()

戻り値

型: String

使用方法

Apex string と EcmaScript string の唯一の違いは、EcmaScript では単一引用符とスラッシュ (/) がエスケープされる点です。

例

1String s1 = '"grade": 3.9/4.0';
2String s2 = s1.escapeEcmaScript();
3System.debug(s2);
4// Output is:
5// \"grade\": 3.9\/4.0
6System.assertEquals(
7   '\\"grade\\": 3.9\\/4.0', 
8    s2);

署名

public String escapeHtml3()

戻り値

型: String

例

1String s1 = 
2   '"<Black&White>"';
3String s2 = 
4   s1.escapeHtml3();
5System.debug(s2);
6// Output:
7// &quot;&lt;Black&amp;
8// White&gt;&quot;

署名

public String escapeHtml4()

戻り値

型: String

例

1String s1 = 
2   '"<Black&White>"';
3String s2 = 
4   s1.escapeHtml4();
5System.debug(s2);
6// Output:
7// &quot;&lt;Black&amp;
8// White&gt;&quot;

署名

public String escapeJava()

戻り値

型: String

エスケープされた文字列。

例

1// Input string contains quotation marks
2String s = 'Company: "Salesforce.com"';
3String escapedStr = s.escapeJava();
4// Output string has the quotes escpaded
5System.assertEquals('Company: \\"Salesforce.com\\"', escapedStr);

署名

public static String escapeSingleQuotes(String stringToEscape)

パラメーター

stringToEscape

型: String

戻り値

型: String

使用方法

このメソッドは動的 SOQL ステートメントの作成時に役に立ち、SOQL インジェクションを回避します。動的 SOQL についての詳細は、「動的 SOQL」を参照してください。

例

1String s = '\'Hello Jason\'';
2system.debug(s); // Outputs 'Hello Jason'
3String escapedStr = String.escapeSingleQuotes(s);
4// Outputs \'Hello Jason\'
5system.debug(escapedStr); 
6// Escapes the string \\\' to string \'
7system.assertEquals('\\\'Hello Jason\\\'', escapedStr);

署名

public String escapeUnicode()

戻り値

型: String

エスケープされた文字列。

例

1String s = 'De onde você é?';
2String escapedStr = s.escapeUnicode();
3System.assertEquals('De onde voc\\u00EA \\u00E9?', escapedStr);

署名

public String escapeXml()

戻り値

型: String

使用方法

5 つの基本 XML エンティティ (gt、lt、quot、amp、apos) のみをサポートします。DTD または外部エンティティはサポートしていません。0x7f より大きい Unicode 文字はエスケープされません。

例

1String s1 = 
2   '"<Black&White>"';
3String s2 = 
4   s1.escapeXml();
5System.debug(s2);
6// Output:
7// &quot;&lt;Black&amp;
8// White&gt;&quot;

署名

public static String format(String stringToFormat, List<Object> formattingArguments)

パラメーター

stringToFormat

型: String

formattingArguments

型: List<Object>

戻り値

型: String

バージョン管理動作の変更

バージョン 51.0 以降、format() メソッドは、stringToFormat パラメーターの単一引用符をサポートし、formattingArguments パラメーターを使用して書式設定された文字列を返します。バージョン 50.0 以前では、単一引用符はサポートされていませんでした。

例

1String template = '{0} was last updated {1}';
2List<Object> parameters = new List<Object> {'Universal Containers', DateTime.newInstance(2018, 11, 15) };
3String formatted = String.format(template, parameters);
4System.debug ('Newly formatted string is:' + formatted);

署名

public static String fromCharArray(List<Integer> charArray)

パラメーター

charArray

型: List<Integer>

戻り値

型: String

例

1List<Integer> charArr= new Integer[]{74};
2String convertedChar = String.fromCharArray(charArr);
3System.assertEquals('J', convertedChar);

署名

public List<Integer> getChars()

戻り値

型: List<Integer>

各整数が文字列内の文字値に対応する、整数のリスト。

例

次の例では、文字列を文字の配列に変換してから、「J」の値に対応する最初の配列要素を取得します。

1String str = 'Jane goes fishing.';
2Integer[] chars = str.getChars();
3// Get the value of 'J'
4System.assertEquals(74, chars[0]);

署名

public static String getCommonPrefix(List<String> strings)

パラメーター

strings

型: List<String>

戻り値

型: String

例

1List<String> ls = new List<String>{'SFDCApex', 'SFDCVisualforce'};
2String prefix = String.getCommonPrefix(ls);
3System.assertEquals('SFDC', prefix);

署名

public Integer getLevenshteinDistance(String stringToCompare)

パラメーター

stringToCompare

型: String

戻り値

型: Integer

使用方法

レーベンシュタイン距離は、ある文字列から別の文字列に変更するために必要な変更の回数です。1 文字の変更 (削除、挿入、または置換) が 1 つの変更としてカウントされます。

例

1String s = 'Hello Joe';
2Integer i = s.getLevenshteinDistance('Hello Max');
3System.assertEquals(3, i);

署名

public Integer getLevenshteinDistance(String stringToCompare, Integer threshold)

パラメーター

stringToCompare

型: String

threshold

型: Integer

戻り値

型: Integer

使用方法

レーベンシュタイン距離は、ある文字列から別の文字列に変更するために必要な変更の回数です。1 文字の変更 (削除、挿入、または置換) が 1 つの変更としてカウントされます。

例:

この例では、レーベンシュタイン距離は 3 ですが、しきい値の引数が 2 でこの距離よりも小さいため、このメソッドは -1 を返します。

例

1String s = 'Hello Jane';
2Integer i = s.getLevenshteinDistance('Hello Max', 2);
3System.assertEquals(-1, i);

署名

public Integer hashCode()

戻り値

型: Integer

使用方法

この値は、Java String.hashCode の同等メソッドによって計算されるハッシュコードに基づきます。

このメソッドを使用して、String メンバー変数を含むカスタム型に対してハッシュコードの計算を簡単にすることができます。各 String 変数のハッシュコードに基づいて、使用しているデータ型のハッシュコードを計算できます。次に例を示します。

カスタム型を持つハッシュコードメソッドの使用の詳細については、「対応付けのキーとセットでのカスタムデータ型の使用」を参照してください。

例

1public class MyCustomClass {
2   String x,y;
3   // Provide a custom hash code
4   public Integer hashCode() {
5    return 
6    (31*x.hashCode())^(y.hashCode());
7   }
8}

署名

public Integer indexOf(String substring)

パラメーター

substring

型: String

戻り値

型: Integer

例

1String myString1 = 'abcde';
2String myString2 = 'cd';
3Integer result = myString1.indexOf(mystring2);
4System.assertEquals(2, result);

署名

public Integer indexOf(String substring, Integer index)

パラメーター

substring

型: String

index

型: Integer

戻り値

型: Integer

例

1String myString1 = 'abcdabcd';
2String myString2 = 'ab';
3Integer result = myString1.indexOf(mystring2, 1);
4System.assertEquals(4, result);

署名

public Integer indexOfAny(String substring)

パラメーター

substring

型: String

戻り値

型: Integer

例

1String s1 = 'abcd';
2String s2 = 'xc';
3Integer result = s1.indexOfAny(s2);
4System.assertEquals(2, result);

署名

public Integer indexOfAnyBut(String substring)

パラメーター

substring

型: String

戻り値

型: Integer

例

1String s1 = 'abcd';
2String s2 = 'xc';
3Integer result = s1.indexOfAnyBut(s2);
4System.assertEquals(0, result);

署名

public Integer indexOfChar(Integer character)

パラメーター

character

型: Integer

文字列内の文字の整数値。

戻り値

型: Integer

指定された文字が最初に出現した位置のインデックス。文字が見つからない場合は -1。

使用方法

このメソッドは、Unicode コードユニットでインデックスを返します。

例

1String str = '\\u03A9 is Ω (Omega)';
2// Returns 0, which is the first character.
3System.debug('indexOfChar(937)=' + str.indexOfChar(937));
4
5// Output:
6// indexOfChar(937)=0

署名

public Integer indexOfChar(Integer character, Integer startIndex)

パラメーター

character

型: Integer

検索する文字の整数値。

startIndex

型: Integer

検索の開始インデックス。

戻り値

型: Integer

指定された開始インデックスから始め、指定された文字が最初に出現した位置のインデックス。文字が見つからない場合は -1。

使用方法

このメソッドは、Unicode コードユニットでインデックスを返します。

例

次の例では、さまざまな方法でオメガ (Ω) 文字のインデックスを検索します。indexOfChar への最初のコールでは、開始インデックスを指定しないため、返されるインデックスは、文字列全体でオメガが最初に出現した位置を示す 0 です。後続のコールでは、開始インデックスを指定して、指定されたインデックスから開始するサブ文字列内でオメガが最初に出現した位置を検索します。

1String str = 'Ω and \\u03A9 and Ω';
2System.debug('indexOfChar(937)=' + str.indexOfChar(937));
3System.debug('indexOfChar(937,1)=' + str.indexOfChar(937,1));
4System.debug('indexOfChar(937,10)=' + str.indexOfChar(937,10));
5
6// Output:
7// indexOfChar(937)=0
8// indexOfChar(937,1)=6, (corresponds to the escaped form \\u03A9)
9// indexOfChar(937,10)=12

署名

public Integer indexOfDifference(String stringToCompare)

パラメーター

stringToCompare

型: String

戻り値

型: Integer

例

1String s1 = 'abcd';
2String s2 = 'abxc';
3Integer result = s1.indexOfDifference(s2);
4System.assertEquals(2, result);

署名

public Integer indexOfIgnoreCase(String substring)

パラメーター

substring

型: String

戻り値

型: Integer

例

1String s1 = 'abcd';
2String s2 = 'BC';
3Integer result = s1.indexOfIgnoreCase(s2, 0);
4System.assertEquals(1, result);

署名

public Integer indexOfIgnoreCase(String substring, Integer startPosition)

パラメーター

substring

型: String

startPosition

型: Integer

戻り値

型: Integer

署名

public Boolean isAllLowerCase()

戻り値

型: Boolean

例

1String allLower = 'abcde';
2System.assert(allLower.isAllLowerCase());

署名

public Boolean isAllUpperCase()

戻り値

型: Boolean

例

1String allUpper = 'ABCDE';
2System.assert(allUpper.isAllUpperCase());