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

description(withLocale:indent:)

Returns a string object that represents the contents of the dictionary, formatted as a property list. 辞書の内容を表す文字列オブジェクトを返します、プロパティリストとして書式設定されます。

Declaration 宣言

func description(withLocale locale: Any?, 
          indent level: Int) -> String

Parameters パラメータ

locale

An object that specifies options used for formatting each of the dictionary’s keys and values; pass nil if you don’t want them formatted. 辞書の持つキーと値のそれぞれを書式設定するために使うオプションを指定するオブジェクト;それらが書式設定されることを望まないならばnilを渡してください。

On iOS and macOS 10.5 and later, either an instance of NSDictionary or an NSLocale object may be used for locale. In OS X v10.4 and earlier it must be an instance of NSDictionary. iOSおよびmacOS 10.5以降では、NSDictionaryのインスタンスまたはNSLocaleオブジェクトのどちらかがlocaleに対して渡されるかもしれません。OS X v10.4以前ではそれはNSDictionaryのインスタンスでなければなりません。

level

Specifies a level of indentation, to make the output more readable: the indentation is (4 spaces) * level. 字下げの水準を指定します、出力をより読みやすくするため:字下げは、 (4つの空白) * levelです。

Return Value 戻り値

A string object that represents the contents of the dictionary, formatted as a property list. 辞書の内容を表す文字列オブジェクト、プロパティリストとして書式設定されます。

Discussion 議論

The returned NSString object contains the string representations of each of the dictionary’s entries. description(withLocale:indent:) obtains the string representation of a given key or value as follows: 返されるNSStringオブジェクトは、辞書の持つ登録項目のそれぞれの文字列表現を含みます。description(withLocale:indent:)は、与えられたキーまたは値の文字列表現を取得します、以下のように:

  • If the object is an NSString object, it is used as is. オブジェクトがNSStringオブジェクトならば、それがそのままで使われます。

  • If the object responds to descriptionWithLocale:indent:, that method is invoked to obtain the object’s string representation. オブジェクトがdescriptionWithLocale:indent:に応答するならば、そのメソッドが発動されて、オブジェクトの文字列表現を取得します。

  • If the object responds to descriptionWithLocale:, that method is invoked to obtain the object’s string representation. オブジェクトがdescriptionWithLocale:に応答するならば、そのメソッドが発動されて、オブジェクトの文字列表現を取得します。

  • If none of the above conditions is met, the object’s string representation is obtained by through its description property. 上の条件のどれにも遭遇しないならば、オブジェクトの持つ文字列表現はそれのdescriptionプロパティを通して取得されます。

If each key in the dictionary responds to compare:, the entries are listed in ascending order, by key. Otherwise, the order in which the entries are listed is undefined. 辞書の中のキーそれぞれがcompare:に応答するならば、それら登録項目は、キーによって昇順でリストされます。そうでなければ、登録項目がリストされる順番は未定義です。

See Also 参照

Describing a Dictionary 辞書を記述する