XCode 7.3 日本語化計画: CAC: API

- initWithObjects:forKeys:

+ dictionaryWithObjects:forKeys:

キーの配列と値の配列の内容から構成されたエントリを含む辞書を作成し、返します。

宣言

<< OBJECTIVE-C >>

+ (instancetype)dictionaryWithObjects:(NSArray<ObjectType> *)objects
                              forKeys:(NSArray<id<NSCopying>> *)keys

パラメータ

objects	新しい辞書の値を含む配列。
keys	新しい辞書のキーを含む配列。各キーは、コピーされ、(copyWithZone: を使用して。キーは NSCopying プロトコルに準拠していなければなりません)コピーが辞書に追加されます。

戻り値

objects と keys の内容から構成されたエントリを含む新しい辞書。

議論

このメソッドは、objects と keys の配列の間をステップを踏むように繰り返し経由し、ステップ毎に新しい辞書内のエントリを作って行きます。オブジェクトとキーが同じ数の要素を持っていない場合には、 NSInvalidArgumentException の例外が発生します。

利用可能

OS X v10.0 以降で利用可能。

以下も見よ

+ dictionaryWithObjects:forKeys:count:

objects の配列から、count のオブジェクトを含む辞書を作成し、返します。

宣言

<< OBJECTIVE-C >>

+ (instancetype)dictionaryWithObjects:(const ObjectType _Nonnull [])objects
                              forKeys:(const id<NSCopying> _Nonnull [])keys
                                count:(NSUInteger)count

パラメータ

objects	新しい辞書の値の C 言語の配列。
keys	新しい辞書のキーの C 言語の配列。各キーは、コピーされ(copyWithZone:を使用して。キーは NSCopying プロトコルに準拠していなければなりません)、コピーが新しい辞書に追加されます。
count	keys と objects の配列から使用する要素の数。count は、objects と keys 内の要素数を超えてはなりません。

議論

このメソッドは、objects と keys 配列の間の行き来を繰り返し、新しい辞書内のエントリを作成します。キーまたは値オブジェクトが nil の場合は NSInvalidArgumentException の例外が発生します。

以下のコードは、ASCII 値とアルファベット文字を関連付ける辞書を作成する方法を示しています。

static const NSInteger N_ENTRIES = 26;
NSDictionary *asciiDict;
NSString *keyArray[N_ENTRIES];
NSNumber *valueArray[N_ENTRIES];
NSInteger i;
for (i = 0; i < N_ENTRIES; i++) {
char charValue = 'a' + i;
keyArray[i] = [NSString stringWithFormat:@"%c", charValue];
valueArray[i] = [NSNumber numberWithChar:charValue];
}
asciiDict = [NSDictionary dictionaryWithObjects:(id *)valueArray
forKeys:(id *)keyArray count:N_ENTRIES];

利用可能

OS X v10.0 以降で利用可能。

以下も見よ

+ dictionaryWithObjects:forKeys:

- initWithObjectsAndKeys:

値とキーの特定のセットから構築されたエントリを含む辞書を作成し、返します。

宣言

<< OBJECTIVE-C >>

+ (instancetype)dictionaryWithObjectsAndKeys:(id)firstObject

, ...

パラメータ

firstObject	新しい辞書に追加する最初の値。
...	firstObject のための最初のキー、そして値とキーが交互に続き、null で終了するリスト。いずれかのキーが nil の場合、NSInvalidArgumentException の例外が発生します。

議論

このメソッドは、dictionaryWithObject:forKey:に似ています。ただ、キー値のペアが指定されている方法が異なります。

たとえば：

NSDictionary *dict = [NSDictionary dictionaryWithObjectsAndKeys:
@"value1", @"key1", @"value2", @"key2", nil];

利用可能

OS X v10.0 以降で利用可能。

以下も見よ

+ dictionaryWithObjects:forKeys:

NSDictionary インスタンスの初期化

- init 指定イニシャライザ

新たに割り当てられた辞書を初期化します。

宣言

<< SWIFT >>

init()

<< OBJECTIVE-C >>

- (instancetype)init

戻り値

辞書。

議論

このメソッドは、NSDictionary の指定イニシャライザです。

利用可能

OS X v10.9 以降で利用可能。

以下も見よ

+ dictionaryWithContentsOfFile:

- initWithContentsOfFile:

与えられたパスにあるファイルで見つかったキー値を使用して、新たに割り当てられた辞書を初期化します。

宣言

<< SWIFT >>

convenience init?(contentsOfFile path: String)

<< OBJECTIVE-C >>

- (NSDictionary<KeyType,ObjectType> *)initWithContentsOfFile:(NSString *)path

パラメータ

path

フルパスまたは相対パス名。path によって識別されるファイルには、プロパティリストのルートオブジェクトが辞書である文字列表現を含んでいなければなりません。

戻り値

初期化された辞書は元の受信者とは異なる場合がありますが、path の所の辞書を含み、ファイルエラーがある場合や、ファイルの内容が、辞書の無効な表現である場合、nil。

議論

利用可能

OS X v10.0 以降で利用可能。

以下も見よ

- initWithContentsOfURL:

与えられた URL で見つかったキー値を使用して、新たに割り当てられた辞書を初期化します。

宣言

<< SWIFT >>

convenience init?(contentsOfURL url: NSURL)

<< OBJECTIVE-C >>

- (NSDictionary<KeyType,ObjectType> *)initWithContentsOfURL:(NSURL *)aURL

パラメータ

aURL

プロパティリストのルートオブジェクトが辞書である文字列表現を含むリソースを識別する URL。

戻り値

初期化された辞書は元の受信者と異なる場合がありますが、aURL の所の辞書を含み、ファイルエラーがある場合や、リソースの内容が辞書の無効な表現である場合、nil。

議論

利用可能

OS X v10.0 以降で利用可能。

以下も見よ

+ dictionaryWithContentsOfURL:

- initWithDictionary:

別の与えられた辞書に含まれるキー値をその中に置くことで、新たに割り当てられた辞書を初期化します。

宣言

<< SWIFT >>

convenience init(dictionary otherDictionary: [NSObject : AnyObject])

<< OBJECTIVE-C >>

- (instancetype)initWithDictionary:(NSDictionary<KeyType,
                            ObjectType> *)otherDictionary

パラメータ

otherDictionary

新しい辞書を初期化するためにどのキー値で行なうかを含む辞書。

戻り値

初期化された辞書は、元の受信者とは異なる場合がありますが、otherDictionary で見つかったキー値を含みます。

利用可能

OS X v10.0 以降で利用可能。

以下も見よ

+ dictionaryWithDictionary:

- initWithDictionary:copyItems:

別の与えられた辞書に含まれているオブジェクトを使用して、新しく割り当てられた辞書を初期化します。

宣言

<< SWIFT >>

convenience init(dictionary otherDictionary: [NSObject : AnyObject],
       copyItems flag: Bool)

<< OBJECTIVE-C >>
- (instancetype)initWithDictionary:(NSDictionary<KeyType,
                                            ObjectType> *)otherDictionary
                         copyItems:(BOOL)flag

パラメータ

otherDictionary

新しい辞書を初期化するためにどのキー値で行なうかを含む辞書。

flag

もし YES なら、otherODictionary の各オブジェクトは copyWithZone: メッセージを受けて、オブジェクトのコピーを作成しますが、オブジェクトは NSCopying プロトコルに準拠している必要があります。管理されたメモリ環境では、これは、オブジェクトが他の場合受け取る、retain メッセージの代わりです。その後オブジェクト·コピーが戻された辞書に追加されます。
もし NO なら、管理されたメモリ環境では、otherDictionary 内の各オブジェクトは単に retain メッセージを、返された辞書に追加されたときに受信します。

戻り値

初期化された辞書は、元の受信者とは異なる場合がありますが、otherDictionary で見つかったキー値を含みます。

議論

変更不能の辞書は、このように初期化された後、変更することはできません。

copyWithZone: メソッドは、浅いコピーを実行します。もし任意の深さのコレクションを持っている場合は、flag パラメータに YES を渡し、表面下の最初のレベルの変更不能コピーを実行します。もし NO を渡すと最初のレベルの可変性は影響を受けません。いずれの場合も、すべてのより深いレベルの可変性は影響を受けません。

利用可能

OS X v10.0 以降で利用可能。

以下も見よ

- initWithDictionary:

- initWithObjects:forKeys:

objects や keys 配列の内容から構成されるエントリで新たに割り当てられた辞書を初期化します。

宣言

<< SWIFT >>

convenience init(objects objects: [AnyObject],
         forKeys keys: [NSCopying])

<< OBJECTIVE-C >>
- (instancetype)initWithObjects:(NSArray<ObjectType> *)objects
                        forKeys:(NSArray<id<NSCopying>> *)keys

パラメータ

objects	新しい辞書の値を含む配列。
keys	新しい辞書のキーを含む配列。各キーは(copyWithZone: を使用して。キーは NSCopying プロトコルに準拠している必要があります)コピーされ、コピーが新しい辞書に追加されます。

議論

このメソッドは、objects と keys の配列の間を交互に行き来し、その度にに新しい辞書のエントリを作成します。オブジェクトとキーの配列が同じ数の要素を持っていない場合Nは >NSInvalidArgumentException の例外が発生します。

利用可能

OS X v10.0 以降で利用可能。

以下も見よ

+ dictionaryWithObjects:forKeys:

- initWithObjectsAndKeys:

- initWithObjects:forKeys:count: 指定イニシャライザ

count の数のエントリで新たに割り当てられた辞書を初期化します。

宣言

<< SWIFT >>

init(objects objects: UnsafePointer<AnyObject?>,
     forKeys keys: UnsafePointer<NSCopying?>,
       count cnt: Int)

<< OBJECTIVE-C >>
- (instancetype)initWithObjects:(const ObjectType _Nonnull [])objects
                        forKeys:(const id<NSCopying> _Nonnull [])keys
                          count:(NSUInteger)count

パラメータ

objects	新しい辞書の値の C 言語の配列。
keys	新しい辞書のキーの C 言語の配列。各キーはコピーされ、(copyWithZone: を使用して。キーは NSCopying プロトコルに準拠している必要があります) コピーが新規の辞書に追加されます。
count	keys と objects の配列から使用する要素の数。count は、objects や keys 内の要素数を超えてはなりません。

議論

このメソッドは、objects と keys の配列の間を交互に行き来し、その度にに新しい辞書のエントリを作成します。キーまたは値のオブジェクトが nil の場合は NSInvalidArgumentException の例外が発生します。

このメソッドは、NSDictionary の指定イニシャライザです。

利用可能

OS X v10.0 以降で利用可能。

以下も見よ

- initWithObjects:forKeys:

– initWithObjectsAndKeys:

- init

- initWithObjectsAndKeys:

値とキーの特定のセットから構築されたエントリで、新たに割り当てられた辞書を初期化します。

宣言

<< OBJECTIVE-C >>

- (instancetype)initWithObjectsAndKeys:(id)firstObject

, ...

パラメータ

firstObject	新しい辞書に加えるべき、最初の値。
...	最初のキーは firstObject のためであり、交互に値とキーが続き、null で終了するリスト。いずれかのキーが nil だと、NSInvalidArgumentException の例外が発生します。

議論

このメソッドは、initWithObjects:forKeys: に似ています。ただ、キー値のペアが指定される方法が異なります。

たとえば：

<< OBJECTIVE-C >>

NSDictionary *dict = [[NSDictionary alloc] initWithObjectsAndKeys:
@"value1", @"key1", @"value2", @"key2", nil];

利用可能

OS X v10.0 以降で利用可能。

以下も見よ

- initWithObjects:forKeys:

共有鍵で最適化された辞書用キーセットの作成

+ sharedKeySetForKeys:

指定されたキーの共有キーセットオブジェクトを作成します。

宣言

<< SWIFT >>

class func sharedKeySetForKeys(_ keys: [NSCopying]) -> AnyObject

<< OBJECTIVE-C >>

+ (id)sharedKeySetForKeys:(NSArray<id<NSCopying>> *)keys

パラメータ

keys

キーの配列。このパラメータが nil の場合、例外が起こります。キーの配列が空の場合、空のキーセットが返されます。

戻り値

共有キーセットのオブジェクト。

議論

重複を含む keys の配列は静かに無視されます。重複したキーのハッシュ値は静かに許可されますが、より低い性能の原因となり、メモリ使用量を増加させる原因となります。

通常は、共有鍵の辞書を作成する前に、一度キーの与えられたセットに対して共有キーセットを作成し、NSMutableDictionary クラスメソッド dictionaryWithSharedKeySet: で使用するため、このメソッドの結果を保存します。

利用可能

OS X v10.8 以降で利用可能。

エントリを数える

count プロパティ

辞書内のエントリの数。(読み取り専用)

宣言

<< SWIFT >>

var count: Int { get }

<< OBJECTIVE-C >>

@property(readonly) NSUInteger count

利用可能

OS X v10.0 以降で利用可能。

辞書の比較

- isEqualToDictionary:

受信者の辞書の内容が別の与えられた辞書の内容と等しいかどうかを示すブール値を返します。

宣言

<< SWIFT >>

func isEqualToDictionary(_ otherDictionary: [NSObject : AnyObject]) -> Bool

<< OBJECTIVE-C >>

- (BOOL)isEqualToDictionary:(NSDictionary<KeyType, ObjectType> *)otherDictionary

パラメータ

otherDictionary

受信者の辞書と比較するべき辞書。

戻り値

もし otherDictionary の内容が、受信者の辞書の内容に等しいければ YES そうでなければ NO。

議論

それぞれの辞書が同じ数のエントリを持っていて、与えられたキーを持っている場合、２つの辞書は等しい内容を持っており、各辞書の対応する値オブジェクトは isEqual: テストをを満たします。

利用可能

OS X v10.0 以降で利用可能。

以下も見よ

isEqual:(NSObject プロトコル)

キー値へのアクセス

allKeys プロパティ

辞書のキーを含む新しい配列、または辞書にエントリを全くなければ空の配列。(読み取り専用)

宣言

<< SWIFT >>

var allKeys: [AnyObject] { get }

<< OBJECTIVE-C >>

@property(readonly, copy) NSArray < KeyType > *allKeys

議論

配列内の要素の順序は定義されていません。

利用可能

OS X v10.0 以降で利用可能。

- allKeysForObject:

辞書内の与えられたオブジェクトの出現場所全てに対応するキーを含む新しい配列を返します。

宣言

<< SWIFT >>

func allKeysForObject(_ anObject: AnyObject) -> [AnyObject]

<< OBJECTIVE-C >>

- (NSArray<KeyType> *)allKeysForObject:(ObjectType)anObject

パラメータ

anObject

辞書で探すべき値。

戻り値

辞書内の anObject の出現場所全てに対応するキーを含む新しい配列。anObject に一致するオブジェクトが全く見つからない場合、空の配列を返します。

議論

それが anObject と等しいかどうかを確認するため、isEqual: メッセージが辞書内の各オブジェクトに送信されます。

利用可能

OS X v10.0 以降で利用可能。

以下も見よ

- keyEnumerator:

allValues プロパティ

辞書の値を含む新しい配列、または辞書にエントリが全くない場合は空の配列。(読み取り専用)

宣言

<< SWIFT >>

var allValues: [AnyObject] { get }

<< OBJECTIVE-C >>

@property(readonly, copy) NSArray < ObjectType > *allValues

議論

配列内の値の順序は定義されません。

利用可能

OS X v10.0 以降で利用可能。

getObjects:andKeys:

(OS X v10.11)

辞書内のキー値の C 配列の参照で返します。

宣言

<< SWIFT >>

func getObjects(_ objects: AutoreleasingUnsafeMutablePointer<AnyObject?>,
        andKeys keys: AutoreleasingUnsafeMutablePointer<AnyObject?>)

<< OBJECTIVE-C >>
- (void)getObjects:(ObjectType _Nonnull [])objects
           andKeys:(KeyType _Nonnull [])keys

パラメータ

objects	戻ったときに、辞書内の値の C の配列を含んでいます。
keys	戻ったときに、辞書のキーの C の配列を含んでいます。

議論

返される配列内の n 番目のオブジェクトがキーで、１対１でキーに対応するように返された配列やキー配列の要素。

利用可能

OS X v10.5 以降で利用可能。

OS X 10.11 で旧式となりました。

以下も見よ

- objectsForKeys:notFoundMarker:

- objectForKey:

- objectForKey:

与えられたキーに関連した値を返します。

宣言

<< SWIFT >>

func objectForKey(_ aKey: AnyObject) -> AnyObject?

<< OBJECTIVE-C >>
- (ObjectType)objectForKey:(KeyType)aKey

パラメータ

aKey

対応する値を返すためのキー。

戻り値

aKey に関連した値、aKey に関連した値がない場合 nil。

利用可能

OS X v10.0 以降で利用可能。

以下も見よ

- objectForKeyedSubscript:

与られたキーに関連した値を返します。

宣言

<< SWIFT >>

subscript (_ key: NSCopying) -> AnyObject? { get }

<< OBJECTIVE-C >>
- (ObjectType)objectForKeyedSubscript:(KeyType)key

パラメータ

key

対応する値を返すためのキー。

戻り値

aKey に関連した値、aKey に関連した値がない場合 >nil。

議論

このメソッドは、objectForKey: と同じように動作します。

利用可能

OS X v10.8 以降で利用可能。

以下も見よ

- valueForKey:

- objectsForKeys:notFoundMarker:

NSArray のように指定された keys に対応した辞書からのオブジェクトのセットを返します。

宣言

<< SWIFT >>

func objectsForKeys(_ keys: [AnyObject],
     notFoundMarker marker: AnyObject) -> [AnyObject]

<< OBJECTIVE-C >>
- (NSArray<ObjectType> *)objectsForKeys:(NSArray<KeyType> *)keys
                         notFoundMarker:(ObjectType)anObject

パラメータ

keys	対応する値を返すためのキーを含む NSArray。
anObject	与られたキーに対応する辞書にオブジェクトが見つからない場合は、マーカーオブジェクトが返された配列の対応する要素内に配置されます。

議論

返される配列と keys 配列ないのオブジェクトは 1対1 で対応しており、返された配列内の n 番目のオブジェクトは、keys の n 番目のキーに対応しています。

利用可能

OS X v10.0 以降で利用可能。

以下も見よ

- valueForKey:

与られたキーに関連した値を返します。

宣言

<< SWIFT >>

func valueForKey(_ key: String) -> AnyObject?

<< OBJECTIVE-C >>
- (ObjectType)valueForKey:(NSString *)key

パラメータ

key

対応する値を返すためのキー。キー値コーディングを使用するときに、キーは文字列でなければならないことに注意してください。(キー値コーディングの基礎 を参照のこと)

戻り値

key に関連した値。

議論

key が"@"で始まらない場合、objectForKey: を呼び出します。key が"@"で始まる場合、"＠"を削除し、キーの他の部分で、[super valueForKey:] を呼び出します。

利用可能

OS X v10.3 以降で利用可能。

以下も見よ

setValue:forKey: (NSMutableDictionary)

列挙型の辞書

- keyEnumerator:

宣言

辞書内の各キーにアクセスすることができるようにする列挙子オブジェクトを返します。

<< OBJECTIVE-C >>

- (NSEnumerator *)keyEnumerator

戻り値

辞書内の各キーにアクセスすることができるようにする列挙子オブジェクト。

議論

以下のコードは、このメソッドを使用する方法を示しています。

NSEnumerator *enumerator = [myDictionary keyEnumerator];
id key;
while ((key = [enumerator nextObject])) {
/* code that uses the returned key */
}

もし NSDictionary の可変のサブクラスのインスタンスで、このメソッドを使用するなら、コードは列挙中にエントリを決して変更しないでください。エントリを変更する場合は、辞書のキーの「スナップショット」を作成するために allKeys プロパティを使用して下さい。その後、道なりにそれらを変更しながら、エントリを注意深く見るために、このスナップショットを使用して下さい。

objectEnumerator メソッドは、辞書内の各値にアクセスするための便利な方法を提供していることに注意してください。

特別な考慮事項

高速列挙プロトコルを使用する方が(NSFastEnumeration を参照) 効率的です。高速列挙は、OS X v10.5 以降、および iOS 2.0 以降で利用可能です。

利用可能

OS X v10.0 以降で利用可能。

以下も見よ

- allKeysForObject:

- enumerateKeysAndObjectsWithOptions:usingBlock:

nextObject (NSEnumerator)

- objectEnumerator

辞書内の各値にアクセスすることができる列挙子オブジェクトを返します。

宣言

<< SWIFT >>

func objectEnumerator() -> NSEnumerator

<< OBJECTIVE-C >>
- (NSEnumerator<ObjectType> *)objectEnumerator

戻り値

辞書内の各値にアクセスすることができる列挙子オブジェクト。

議論

以下のコードで、メソッドの使用方法を示します。

NSEnumerator *enumerator = [myDictionary objectEnumerator];
id value;
while ((value = [enumerator nextObject])) {
/* code that acts on the dictionary’s values */
}

NSDictionary の可変のサブクラスのインスタンスでこのメソッドを使用する場合、コードは列挙中にエントリを変更すべきではありません。エントリを変更しようとする場合は、辞書の値の"スナップショット" を作成するために allValues メソッドを使用して下さい。値を変更するには、このスナップショットから作業して下さい。

≈

特別な考慮事項

高速列挙プロトコルを使用する方が効率的です(NSFastEnumeration を参照のこと)。高速列挙は、OS X v10.5 以降か、iOS 2.0 以降で利用可能です。

利用可能

OS X v10.0 以降で利用可能。

以下も見よ

- keyEnumerator

nextObject (NSEnumerator)

- enumerateKeysAndObjectsUsingBlock:

辞書のエントリに、与えられたブロックオブジェクトを適用します。

宣言

<< SWIFT >>

- (void)enumerateKeysAndObjectsUsingBlock:(void (^)(id key, id obj, BOOL *stop))block

func enumerateKeysAndObjectsUsingBlock(_ block: (AnyObject,
                                                AnyObject,
                                                UnsafeMutablePointer<ObjCBool>) -> Void)

<< OBJECTIVE-C >>
- (void)enumerateKeysAndObjectsUsingBlock:(void (^)(KeyType key,
                                            ObjectType obj,
                                            BOOL *stop))block

パラメータ

block

辞書内のエントリを操作するためのブロックオブジェクト。

議論

ブロックが *stop を YES に設定した場合、列挙は停止します。

利用可能

OS X v10.6 以降で利用可能。

以下も見よ

辞書のエントリに、与えられたブロックオブジェクトを適用します。

宣言

<< SWIFT >>

func enumerateKeysAndObjectsWithOptions(_ opts: NSEnumerationOptions,
                             usingBlock block: (AnyObject,
                                                 AnyObject,
                                                 UnsafeMutablePointer<ObjCBool>) -> Void)

<< OBJECTIVE-C >>
- (void)enumerateKeysAndObjectsWithOptions:(NSEnumerationOptions)opts
                                usingBlock:(void (^)(KeyType key,
                                                     ObjectType obj,
                                                     BOOL *stop))block

パラメータ

opts	列挙のオプション。
block	辞書内のエントリを操作するためのブロックオブジェクト。

議論

ブロックが *stop を YES に設定した場合、列挙は停止します。

利用可能

OS X v10.6 以降で利用可能。

以下も見よ

- enumerateKeysAndObjectsUsingBlock:

辞書の並べ替え

- keysSortedByValueUsingSelector:

辞書が、その値でソートした場合の順序で、辞書のキーの配列を返します。

宣言

<< SWIFT >>

func keysSortedByValueUsingSelector(_ comparator: Selector) -> [AnyObject]

<< OBJECTIVE-C >>
- (NSArray<KeyType> *)keysSortedByValueUsingSelector:(SEL)comparator

パラメータ

comparator

辞書内の値を比較するために使用するメソッドを指定するセレクタ。
辞書の値が引数より小さい場合、comparator メソッドは NSOrderedAscending を返し、辞書の値が引数よりも大きい場合は NSOrderedDescending を返し、もし両者が等しければ NSOrderedSame を返します。

戻り値

辞書が、その値でソートした時の順番で、辞書のキーの配列。

議論

辞書の値のペアは、comparator で指定された比較メソッドを使用して比較されます。comparator メッセージは、値のいずれか１つに送信され、辞書からの他の値を、その１つの引数として有しています。

利用可能

OS X v10.6 以降で利用可能。

以下も見よ