![]() |
API 0.9.5
|
A mutable key-value pair collection. More...
#import <CPDictionary.h>
Instance Methods | |
(void) | - addEntriesFromDictionary: |
(CPArray) | - allKeys |
(CPArray) | - allKeysForObject: |
(CPArray) | - allValues |
(BOOL) | - containsKey: |
(CPDictionary) | - copy |
(int) | - count |
(CPString) | - description |
(void) | - encodeWithCoder: |
(id) | - initWithCoder: |
(id) | - initWithDictionary: |
(id) | - initWithObjects:forKeys: |
(id) | - initWithObjectsAndKeys: |
(CPDictionary) | - inverseChangeDictionary |
(BOOL) | - isEqual: |
(BOOL) | - isEqualToDictionary: |
(CPEnumerator) | - keyEnumerator |
(CPArray) | - keysSortedByValueUsingSelector: |
(CPEnumerator) | - objectEnumerator |
(id) | - objectForKey: |
(void) | - removeAllObjects |
(void) | - removeObjectForKey: |
(void) | - removeObjectsForKeys: |
(void) | - setObject:forKey: |
(void) | - setValue:forKey: |
(id) | - valueForKey: |
Class Methods | |
(id) | + alloc |
(id) | + dictionary |
(id) | + dictionaryWithDictionary: |
(id) | + dictionaryWithJSObject: |
(id) | + dictionaryWithJSObject:recursively: |
(id) | + dictionaryWithObject:forKey: |
(id) | + dictionaryWithObjects:forKeys: |
(id) | + dictionaryWithObjectsAndKeys: |
A mutable key-value pair collection.
A dictionary is the standard way of passing around key-value pairs in the Cappuccino framework. It is similar to the Java map interface, except all keys are CPStrings and values can be any Cappuccino or JavaScript object.
If you are familiar with dictionaries in Cocoa, you'll notice that there is no CPMutableDictionary class. The regular CPDictionary has -setObject
:forKey: and -removeObjectForKey
: methods. In Cappuccino there is no distinction between immutable and mutable classes. They are all mutable.
Definition at line 2 of file CPDictionary.h.
- (void) addEntriesFromDictionary: | (CPDictionary) | aDictionary |
Take all the key/value pairs in aDictionary and apply them to this dictionary.
Definition at line 554 of file CPDictionary.j.
- (CPArray) allKeys |
Returns an array of keys for all the entries in the dictionary.
Definition at line 326 of file CPDictionary.j.
- (CPArray) allKeysForObject: | (id) | anObject |
Returns a new array containing the keys corresponding to all occurrences of a given object in the receiver.
anObject | The value to look for in the receiver. |
Each object in the receiver is sent an isEqual: message to determine if it's equal to anObject. If the check for isEqual fails a check is made to see if the two objects are the same object. This provides compatibility for JSObjects.
Definition at line 353 of file CPDictionary.j.
+ (id) alloc |
Definition at line 81 of file CPDictionary.j.
- (CPArray) allValues |
Returns an array of values for all the entries in the dictionary.
Definition at line 334 of file CPDictionary.j.
- (BOOL) containsKey: | (id) | aKey |
Definition at line 578 of file CPDictionary.j.
- (CPDictionary) copy |
return a copy of the receiver (does not deep copy the objects contained in the dictionary).
Definition at line 310 of file CPDictionary.j.
- (int) count |
Returns the number of entries in the dictionary
Definition at line 318 of file CPDictionary.j.
- (CPString) description |
Returns a human readable description of the dictionary.
Definition at line 573 of file CPDictionary.j.
+ (id) dictionary |
Returns a new empty CPDictionary.
Definition at line 91 of file CPDictionary.j.
+ (id) dictionaryWithDictionary: | (CPDictionary) | aDictionary |
Returns a new dictionary, initialized with the contents of aDictionary
.
aDictionary | the dictionary to copy key-value pairs from |
Definition at line 101 of file CPDictionary.j.
+ (id) dictionaryWithJSObject: | (JSObject) | object |
Creates a dictionary with multiple key-value pairs.
JavaScript | object |
Definition at line 134 of file CPDictionary.j.
+ (id) dictionaryWithJSObject: | (JSObject) | object | |
recursively: | (BOOL) | recursively | |
Creates a dictionary with multiple key-value pairs, recursively.
JavaScript | object |
Definition at line 144 of file CPDictionary.j.
+ (id) dictionaryWithObject: | (id) | anObject | |
forKey: | (id) | aKey | |
Creates a new dictionary with single key-value pair.
anObject | the object for the paring |
aKey | the key for the pairing |
Definition at line 112 of file CPDictionary.j.
Creates a dictionary with multiple key-value pairs.
objects | the objects to place in the dictionary |
keys | the keys for each of the objects |
CPInvalidArgumentException | if the number of objects and keys is different |
Definition at line 124 of file CPDictionary.j.
+ (id) dictionaryWithObjectsAndKeys: | (id) | firstObject | |
, | ... | ||
Creates and returns a dictionary constructed by a given pairs of keys and values.
firstObject | first object value |
... | key for the first object and ongoing value-key pairs for more objects. |
CPInvalidArgumentException | if the number of objects and keys is different |
Assuming that there's no object retaining in Cappuccino, you can create dictionaries same way as with alloc and initWithObjectsAndKeys: var dict = [CPDictionary dictionaryWithObjectsAndKeys: "value1", @"key1", @"value2", @"key2"];
Note, that there's no final nil like in Objective-C/Cocoa.
Definition at line 216 of file CPDictionary.j.
- (void) encodeWithCoder: | (CPCoder) | aCoder |
Archives the dictionary to a provided coder.
aCoder | the coder to which the dictionary data will be archived. |
Definition at line 601 of file CPDictionary.j.
- (id) initWithCoder: | (CPCoder) | aCoder |
Definition at line 592 of file CPDictionary.j.
- (id) initWithDictionary: | (CPDictionary) | aDictionary |
Initializes the dictionary with the contents of another dictionary.
aDictionary | the dictionary to copy key-value pairs from |
Definition at line 229 of file CPDictionary.j.
Initializes the dictionary from the arrays of keys and objects.
objects | the objects to put in the dictionary |
keyArray | the keys for the objects to put in the dictionary |
CPInvalidArgumentException | if the number of objects and keys is different |
Definition at line 247 of file CPDictionary.j.
- (id) initWithObjectsAndKeys: | (id) | firstObject | |
, | ... | ||
Creates and returns a dictionary constructed by a given pairs of keys and values.
firstObject | first object value |
... | key for the first object and ongoing value-key pairs for more objects. |
CPInvalidArgumentException | if the number of objects and keys is different |
You can create dictionaries this way: var dict = [[CPDictionary alloc] initWithObjectsAndKeys: "value1", @"key1", @"value2", @"key2"];
Note, that there's no final nil like in Objective-C/Cocoa.
Definition at line 279 of file CPDictionary.j.
- (CPDictionary) inverseChangeDictionary |
Definition at line 125 of file CPKeyValueObserving.j.
- (BOOL) isEqual: | (id) | anObject |
Definition at line 433 of file CPDictionary.j.
- (BOOL) isEqualToDictionary: | (CPDictionary) | aDictionary |
Compare the receiver to this dictionary, and return whether or not they are equal.
Definition at line 403 of file CPDictionary.j.
- (CPEnumerator) keyEnumerator |
Returns an enumerator that enumerates over all the dictionary's keys.
Definition at line 387 of file CPDictionary.j.
- (CPArray) keysSortedByValueUsingSelector: | (SEL) | theSelector |
Definition at line 374 of file CPDictionary.j.
- (CPEnumerator) objectEnumerator |
Returns an enumerator that enumerates over all the dictionary's values.
Definition at line 395 of file CPDictionary.j.
- (id) objectForKey: | (id) | aKey |
Returns the object for the entry with key aKey
.
aKey | the key for the object's entry |
Definition at line 472 of file CPDictionary.j.
- (void) removeAllObjects |
Removes all the entries from the dictionary.
Definition at line 503 of file CPDictionary.j.
- (void) removeObjectForKey: | (id) | aKey |
Removes the entry for the specified key.
aKey | the key of the entry to be removed |
Definition at line 512 of file CPDictionary.j.
- (void) removeObjectsForKeys: | (CPArray) | keysForRemoval |
Removes each entry in allKeys from the receiver.
allKeys | an array of keys that will be removed from the dictionary |
Definition at line 521 of file CPDictionary.j.
- (void) setObject: | (id) | anObject | |
forKey: | (id) | aKey | |
Adds an entry into the dictionary.
anObject | the object for the entry |
aKey | the entry's key |
Definition at line 546 of file CPDictionary.j.
- (void) setValue: | (id) | aValue | |
forKey: | (CPString) | aKey | |
Reimplemented from CPObject.
Definition at line 262 of file CPKeyValueCoding.j.
- (id) valueForKey: | (CPString) | aKey |
Reimplemented from CPObject.
Definition at line 254 of file CPKeyValueCoding.j.