Instance Method インスタンスメソッド

compare(_:options:range:locale:)

Compares the string using the specified options and returns the lexical ordering for the range. 文字列を指定されたオプションを使って比較して、範囲の語彙的順序を返します。

Declaration 宣言 

func compare(_ string: String, 
     options mask: NSString.CompareOptions = [], 
       range rangeOfReceiverToCompare: NSRange, 
      locale: Any?) -> ComparisonResult

Parameters パラメータ

aString

The string with which to compare the range of the receiver specified by range. rangeによって指定されるレシーバの範囲と比較する文字列。

This value must not be nil. If this value is nil, the behavior is undefined and may change in future versions of macOS. この値は、nilではいけません。この値がnilならば、その挙動は未定義です、そして将来のバージョンのmacOSでは変わるかもしれません。

mask

Options for the search—you can combine any of the following using a C bitwise OR operator: NSCaseInsensitiveSearch, NSLiteralSearch, NSNumericSearch. 検索のためのオプション — あなたはCビット単位OR演算子を使って以下のいずれかを結合できます：NSCaseInsensitiveSearch、NSLiteralSearch、NSNumericSearch。

See String Programming Guide for details on these options. String Programming Guideをこれらオプションの詳細として見てください。

range

The range of the receiver over which to perform the comparison. The range must not exceed the bounds of the receiver. それに対して比較を実行することになるレシーバの範囲。範囲は、レシーバの境界を越えてはいけません。

locale

An instance of NSLocale. To use the current locale, pass [NSLocale current]. For example, if you are comparing strings to present to the end-user, use the current locale. To use the system locale, pass nil. NSLocaleのインスタンス。現在のロケールを使うには、[NSLocale current]を渡してください。例えば、あなたがエンドユーザに提示する文字列それらを比較しているならば、現在のロケールを使ってください。システムロケールを使うには、nilを渡してください。

Return Value 戻り値

Returns an ComparisonResult value that indicates the lexical ordering of a specified range within the receiver and a given string. ComparisonResult.orderedAscending if the substring of the receiver given by range precedes aString in lexical ordering for the locale given in dict, ComparisonResult.orderedSame if the substring of the receiver and aString are equivalent in lexical value, and ComparisonResult.orderedDescending if the substring of the receiver follows aString. あるComparisonResult値を返します、それはレシーバ内のある指定された範囲とある与えられた文字列の語彙的順序を指し示します。ComparisonResult.orderedAscendingをもしrangeによって与えられるレシーバの下位文字列がaStringにdictで与えられたロケールに対する語彙的順序において先行するならば、ComparisonResult.orderedSameをもしレシーバの下位文字列とaStringが語彙的値において同等ならば、そしてComparisonResult.orderedDescendingをレシーバの下位文字列がaStringに続くならば。

Discussion 議論

The locale argument affects both equality and ordering algorithms. For example, in some locales, accented characters are ordered immediately after the base; other locales order them after “z”. locale引数は、同等性と順番付けアルゴリズムの両方に影響を与えます。例えば、いくつかのロケールにおいて、アクセント文字はベースの直後に順番付けられます；他のロケールはそれらを “z” の後に順番付けます。

See Also 参照

Identifying and Comparing Strings 文字列を識別および比較する

func caseInsensitiveCompare(String) -> ComparisonResult
Returns the result of invoking compare(_:options:) with NSCaseInsensitiveSearch as the only option. compare(_:options:)を発動する結果を返します、NSCaseInsensitiveSearchを唯一の引数として使います。
func localizedCaseInsensitiveCompare(String) -> ComparisonResult
Compares the string with a given string using a case-insensitive, localized, comparison. この文字列をある与えられた文字列と比較します、ケースを考慮しない、ローカライズされた比較を使います。
func compare(String) -> ComparisonResult
Returns the result of invoking compare(_:options:range:) with no options and the receiver’s full extent as the range. compare(_:options:range:)を発動する結果を返します、オプション無しそしてレシーバの持つ完全な広がりを範囲として使います。
func localizedCompare(String) -> ComparisonResult
Compares the string and a given string using a localized comparison. ローカライズされた比較を使って、文字列をある与えられた文字列と比較します。
func compare(String, options: NSString.CompareOptions) -> ComparisonResult
Compares the string with the specified string using the given options. 文字列をこの指定された文字列とこの与えられたオプションを使って比較します。
func compare(String, options: NSString.CompareOptions, range: NSRange) -> ComparisonResult
Returns the result of invoking compare(_:options:range:locale:) with a nil locale. compare(_:options:range:locale:)を発動する結果を返します、nilロケールを使います。
func localizedStandardCompare(String) -> ComparisonResult
Compares strings as sorted by the Finder. 文字列をFinderによってソートされる通りに比較します。
func hasPrefix(String) -> Bool
Returns a Boolean value that indicates whether a given string matches the beginning characters of the receiver. あるブール値を返します、与えられた文字列がレシーバの始まりの文字に合致するかどうかを指し示します。
func hasSuffix(String) -> Bool
Returns a Boolean value that indicates whether a given string matches the ending characters of the receiver. あるブール値を返します、与えられた文字列がレシーバの終わりの文字に合致するかどうかを指し示します。
func isEqual(to: String) -> Bool
Returns a Boolean value that indicates whether a given string is equal to the receiver using a literal Unicode-based comparison. あるブール値を返します、与えられた文字列がレシーバと等しいかどうかを指し示します、リテラルユニコード基盤の比較を使います。
var hash: Int
An unsigned integer that can be used as a hash table address. ハッシュテーブルアドレスとして使われることができる符号なし整数。
struct NSString.CompareOptions
These values represent the options available to many of the string classes’ search and comparison methods. これらの値は、文字列クラスのもつ検索および比較メソッドの多くで利用可能なオプションを表します。
struct NSString.EncodingConversionOptions
Options for converting string encodings. 文字列符号化の変換に対するオプション。