String クラス

署名

public String abbreviate(Integer maxWidth)

パラメータ

maxWidth

型: Integer

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

戻り値

型: String

例

署名

public String abbreviate(Integer maxWidth, Integer offset)

パラメータ

maxWidth

型: Integer

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

offset

型: Integer

戻り値

型: String

例

署名

public String capitalize()

戻り値

型: String

使用方法

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

例

署名

public String center(Integer size)

パラメータ

size

型: Integer

戻り値

型: String

例

署名

public String center(Integer size, String paddingString)

パラメータ

size

型: Integer

paddingString

型: String

戻り値

型: String

例

署名

public Integer charAt(Integer index)

パラメータ

index

型: Integer

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

戻り値

型: Integer

文字の整数値。

使用方法

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

例

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

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

署名

public Integer codePointAt(Integer index)

パラメータ

index

型: Integer

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

戻り値

型: Integer

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

使用方法

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

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

例

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

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

署名

public Integer codePointBefore(Integer index)

パラメータ

index

型: Integer

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

戻り値

型: Integer

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

使用方法

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

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

例

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

署名

public Integer codePointCount(Integer beginIndex, Integer endIndex)

パラメータ

beginIndex

型: Integer

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

endIndex

型: Integer

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

戻り値

型: Integer

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

使用方法

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

例

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

署名

public Integer compareTo(String secondString)

パラメータ

secondString

型: String

戻り値

型: Integer

使用方法

結果は次のとおりです。

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

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

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

例

署名

public Boolean contains(String substring)

パラメータ

substring

型: String

戻り値

型: Boolean

例

署名

public Boolean containsAny(String inputString)

パラメータ

inputString

型: String

戻り値

型: Boolean

例

署名

public Boolean containsIgnoreCase(String substring)

パラメータ

substring

型: String

戻り値

型: Boolean

例

署名

public Boolean containsNone(String inputString)

パラメータ

inputString

型: String

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

戻り値

型: Boolean

例

署名

public Boolean containsOnly(String inputString)

パラメータ

inputString

型: String

戻り値

型: Boolean

例

署名

public Boolean containsWhitespace()

戻り値

型: Boolean

例

署名

public Integer countMatches(String substring)

パラメータ

substring

型: String

戻り値

型: Integer

例

署名

public String deleteWhitespace()

戻り値

型: String

例

署名

public String difference(String secondString)

パラメータ

secondString

型: String

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

戻り値

型: String

例

署名

public Boolean endsWith(String suffix)

パラメータ

suffix

型: String

戻り値

型: Boolean

例

署名

public Boolean endsWithIgnoreCase(String suffix)

パラメータ

suffix

型: String

戻り値

型: Boolean

例

署名

public Boolean equals(String secondString)

パラメータ

secondString

型: String

戻り値

型: Boolean

使用方法

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

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

例

署名

public Boolean equals(Object stringOrId)

パラメータ

stringOrId

型: Object

戻り値

型: Boolean

使用方法

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

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

例

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

署名

public Boolean equalsIgnoreCase(String secondString)

パラメータ

secondString

型: String

戻り値

型: Boolean

例

署名

public String escapeCsv()

戻り値

型: String

使用方法

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

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

例

署名

public String escapeEcmaScript()

戻り値

型: String

使用方法

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

例

署名

public String escapeHtml3()

戻り値

型: String

例

署名

public String escapeHtml4()

戻り値

型: String

例

署名

public String escapeJava()

戻り値

型: String

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

例

署名

public static String escapeSingleQuotes(String stringToEscape)

パラメータ

stringToEscape

型: String

戻り値

型: String

使用方法

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

例

署名

public String escapeUnicode()

戻り値

型: String

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

例

署名

public String escapeXml()

戻り値

型: String

使用方法

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

例

署名

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

パラメータ

stringToFormat

型: String

formattingArguments

型: List<Object>

戻り値

型: String

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

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

例

署名

public static String fromCharArray(List<Integer> charArray)

パラメータ

charArray

型: List<Integer>

戻り値

型: String

例

署名

public List<Integer> getChars()

戻り値

型: List<Integer>

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

例

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

署名

public static String getCommonPrefix(List<String> strings)

パラメータ

strings

型: List<String>

戻り値

型: String

例

署名

public Integer getLevenshteinDistance(String stringToCompare)

パラメータ

stringToCompare

型: String

戻り値

型: Integer

使用方法

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

例

署名

public Integer getLevenshteinDistance(String stringToCompare, Integer threshold)

パラメータ

stringToCompare

型: String

threshold

型: Integer

戻り値

型: Integer

使用方法

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

例:

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

例

署名

public Integer hashCode()

戻り値

型: Integer

使用方法

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

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

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

例

署名

public Integer indexOf(String substring)

パラメータ

substring

型: String

戻り値

型: Integer

例

署名

public Integer indexOf(String substring, Integer index)

パラメータ

substring

型: String

index

型: Integer

戻り値

型: Integer

例

署名

public Integer indexOfAny(String substring)

パラメータ

substring

型: String

戻り値

型: Integer

例

署名

public Integer indexOfAnyBut(String substring)

パラメータ

substring

型: String

戻り値

型: Integer

例

署名

public Integer indexOfChar(Integer character)

パラメータ

character

型: Integer

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

戻り値

型: Integer

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

使用方法

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

例

署名

public Integer indexOfChar(Integer character, Integer startIndex)

パラメータ

character

型: Integer

検索する文字の整数値。

startIndex

型: Integer

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

戻り値

型: Integer

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

使用方法

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

例

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

署名

public Integer indexOfDifference(String stringToCompare)

パラメータ

stringToCompare

型: String

戻り値

型: Integer

例

署名

public Integer indexOfIgnoreCase(String substring)

パラメータ

substring

型: String

戻り値

型: Integer

例

署名

public Integer indexOfIgnoreCase(String substring, Integer startPosition)

パラメータ

substring

型: String

startPosition

型: Integer

戻り値

型: Integer

署名

public Boolean isAllLowerCase()

戻り値

型: Boolean

例

署名

public Boolean isAllUpperCase()

戻り値

型: Boolean

例

署名

public Boolean isAlpha()

戻り値

型: Boolean

例

署名

public Boolean isAlphaSpace()

戻り値

型: Boolean

例

署名

public Boolean isAlphanumeric()

戻り値

型: Boolean

例

署名

public Boolean isAlphanumericSpace()

戻り値

型: Boolean

例

署名

public Boolean isAsciiPrintable()

戻り値

型: Boolean

例

署名

public static Boolean isBlank(String inputString)

パラメータ

inputString

型: String

戻り値

型: Boolean

例

署名

public static Boolean isEmpty(String inputString)

パラメータ

inputString

型: String

戻り値

型: Boolean

例

署名

public static Boolean isNotBlank(String inputString)

パラメータ

inputString

型: String

戻り値

型: Boolean

例

署名

public static Boolean isNotEmpty(String inputString)

パラメータ

inputString

型: String

戻り値

型: Boolean

例

署名

public Boolean isNumeric()

戻り値

型: Boolean

使用方法

小数点 (1.2) は Unicode 数字ではありません。

例

署名

public Boolean isNumericSpace()

戻り値

型: Boolean

使用方法

小数点 (1.2) は Unicode 数字ではありません。

例

署名

public Boolean isWhitespace()

戻り値

型: Boolean

例

署名

public static String join(Object iterableObj, String separator)

パラメータ

iterableObj

型: Object

separator

型: String

戻り値

型: String

使用方法

署名

public Integer lastIndexOf(String substring)

パラメータ

substring

型: String

戻り値

型: Integer

例

署名

public Integer lastIndexOf(String substring, Integer endPosition)

パラメータ

substring

型: String

endPosition

型: Integer

戻り値

型: Integer

使用方法

サブ文字列がない場合または endPosition が負の場合、このメソッドは -1 を返します。endPosition が現在の string の最後のインデックスよりも大きい場合、string 全体が検索されます。

例

署名

public Integer lastIndexOfChar(Integer character)

パラメータ

character

型: Integer

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

戻り値

型: Integer

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

使用方法

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

例

署名

public Integer lastIndexOfChar(Integer character, Integer endIndex)

パラメータ

character

型: Integer

検索する文字の整数値。

endIndex

型: Integer

検索の終了インデックス。

戻り値

型: Integer

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

使用方法

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

例

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

署名

public Integer lastIndexOfIgnoreCase(String substring)

パラメータ

substring

型: String

戻り値

型: Integer

使用方法

サブ文字列がない場合、このメソッドは -1 を返します。

例

署名

public Integer lastIndexOfIgnoreCase(String substring, Integer endPosition)

パラメータ

substring

型: String

endPosition

型: Integer

戻り値

型: Integer

使用方法

サブ文字列がない場合または endPosition が負の場合、このメソッドは -1 を返します。endPosition が現在の string の最後のインデックスよりも大きい場合、string 全体が検索されます。

例

署名

public String left(Integer length)

パラメータ

length

型: Integer

戻り値

型: String

使用方法

length が string のサイズよりも大きい場合、string 全体が返されます。

例

署名

public String leftPad(Integer length)

パラメータ

length

型: Integer

使用方法

length が現在の string サイズ以下の場合、string 全体が空白の埋め込みなしで返されます。

戻り値

型: String

例

署名

public String leftPad(Integer length, String padStr)

パラメータ

length

型: Integer

padStr

型: String

埋め込む文字列。null または空の場合は、1 文字の空白として扱われます。

使用方法

length が現在の string サイズ以下の場合、string 全体が空白の埋め込みなしで返されます。

戻り値

型: String

例

署名

public Integer length()

戻り値

型: Integer

例

署名

public String mid(Integer startIndex, Integer length)

パラメータ

startIndex

型: Integer

startIndex が負の場合は、0 とみなされます。

length

型: Integer

length が負または 0 の場合、空の string が返されます。length が残りの文字数よりも大きい場合、string の残りが返されます。

戻り値

型: String

使用方法

このメソッドは、substring(startIndex) メソッドと substring(startIndex, endIndex) メソッドに類似していますが、2 番目の引数が返される文字数である点が異なります。

例

署名

public String normalizeSpace()

戻り値

型: String

使用方法

このメソッドは、空白文字 (スペース、タブ (\t)、改行 (\n)、行頭復帰 (\r)、およびフォームフィード (\f)) を正規化します。

例

署名

public Integer offsetByCodePoints(Integer index, Integer codePointOffset)

パラメータ

index

型: Integer

文字列内の開始インデックス。

codePointOffset

型: Integer

オフセットするコードポイント数。

戻り値

型: Integer

オフセットに開始インデックスを加算した値に対応するインデックス。

使用方法

index で指定されたテキスト範囲内でペアになっていないサロゲートは、codePointOffset でそれぞれ 1 つのコードポイントとして数えられます。

例

次の例では、開始インデックス 0 (最初の文字から開始) で 3 コードポイントをオフセットした位置から始まる文字列に対して offsetByCodePoints をコールします。文字列には、エスケープされた形式の補助文字のシーケンスが 1 つ (文字のペアが 1 組) 含まれます。文字列の先頭から数えて 3 コードポイントをオフセットした結果、返されるコードポイントインデックスは 4 です。

署名

public String remove(String substring)

パラメータ

substring

型: String

戻り値

型: String

例

署名

public String removeEnd(String substring)

パラメータ

substring

型: String

戻り値

型: String

例

署名

public String removeEndIgnoreCase(String substring)

パラメータ

substring

型: String

戻り値

型: String

例

署名

public String removeStart(String substring)

パラメータ

substring

型: String

戻り値

型: String

例

署名

public String removeStartIgnoreCase(String substring)

パラメータ

substring

型: String

戻り値

型: String

例

署名

public String repeat(Integer numberOfTimes)

パラメータ

numberOfTimes

型: Integer

戻り値

型: String

例

署名

public String repeat(String separator, Integer numberOfTimes)

パラメータ

separator

型: String

numberOfTimes

型: Integer

戻り値

型: String

例

署名

public String replace(String target, String replacement)

パラメータ

target

型: String

replacement

型: String

戻り値

型: String

例

署名

public String replaceAll(String regExp, String replacement)

パラメータ

regExp

型: String

replacement

型: String

戻り値

型: String

使用方法

正規表現についての詳細は、Java Pattern クラスを参照してください。

例

署名

public String replaceFirst(String regExp, String replacement)

パラメータ

regExp

型: String

replacement

型: String

戻り値

型: String

使用方法

正規表現についての詳細は、Java Pattern クラスを参照してください。

例

署名

public String reverse()

戻り値

型: String

署名

public String right(Integer length)

パラメータ

length

型: Integer

length が string のサイズよりも大きい場合、string 全体が返されます。

戻り値

型: String

例

署名

public String rightPad(Integer length)

パラメータ

length

型: Integer

length が現在の string サイズ以下の場合、string 全体が空白の埋め込みなしで返されます。

戻り値

型: String

例