CPDictionary Class Reference

A mutable key-value pair collection. More...

#import <CPDictionary.h>

Inheritance diagram for CPDictionary:

Instance Methods
(void)	- addEntriesFromDictionary:
(CPArray)	- allKeys
(CPArray)	- allKeysForObject:
(CPArray)	- allValues
(BOOL)	- containsKey:
(CPDictionary)	- copy
(int)	- count
(CPString)	- description
(void)	- encodeWithCoder:
(void)	- enumerateKeysAndObjectsUsingBlock:
(void)	- enumerateKeysAndObjectsWithOptions:usingBlock:
(id)	- initWithCoder:
(id)	- initWithDictionary:
(id)	- initWithObjects:forKeys:
(id)	- initWithObjectsAndKeys:
(CPDictionary)	- inverseChangeDictionary
(BOOL)	- isEqual:
(BOOL)	- isEqualToDictionary:
(CPEnumerator)	- keyEnumerator
(CPArray)	- keysOfEntriesPassingTest:
(CPArray)	- keysOfEntriesWithOptions:passingTest:
(CPArray)	- keysSortedByValueUsingComparator:
(CPArray)	- keysSortedByValueUsingSelector:
(CPEnumerator)	- objectEnumerator
(id)	- objectForKey:
(void)	- removeAllObjects
(void)	- removeObjectForKey:
(void)	- removeObjectsForKeys:
(void)	- setObject:forKey:
(void)	- setValue:forKey:
(id)	- valueForKey:
Instance Methods inherited from CPObject
(void)	- addObserver:forKeyPath:options:context:
(void)	- applyChange:toKeyPath:
(id)	- autorelease
(id)	- awakeAfterUsingCoder:
(void)	- awakeFromCib
(void)	- bind:toObject:withKeyPath:options:
(Class)	- classForCoder
(Class)	- classForKeyedArchiver
(CPString)	- className
(void)	- dealloc
(CPDictionary)	- dictionaryWithValuesForKeys:
(void)	- didChange:valuesAtIndexes:forKey:
(void)	- didChangeValueForKey:
(void)	- didChangeValueForKey:withSetMutation:usingObjects:
(void)	- doesNotRecognizeSelector:
(CPArray)	- exposedBindings
(id)	- forwardingTargetForSelector:
(void)	- forwardInvocation:
(unsigned)	- hash
(BOOL)	- implementsSelector:
(CPDictionary)	- infoForBinding:
(id)	- init
(BOOL)	- isKindOfClass:
(BOOL)	- isMemberOfClass:
(BOOL)	- isProxy
(IMP)	- methodForSelector:
(CPMethodSignature)	- methodSignatureForSelector:
(id)	- mutableArrayValueForKey:
(id)	- mutableArrayValueForKeyPath:
(id)	- mutableCopy
(id)	- mutableSetValueForKey:
(id)	- mutableSetValueForKeyPath:
(id)	- performSelector:
(id)	- performSelector:withObject:
(id)	- performSelector:withObject:withObject:
(id)	- performSelector:withObjects:
(void)	- release
(void)	- removeObserver:forKeyPath:
(id)	- replacementObjectForArchiver:
(id)	- replacementObjectForCoder:
(id)	- replacementObjectForKeyedArchiver:
(BOOL)	- respondsToSelector:
(id)	- retain
(id)	- self
(void)	- setValue:forKeyPath:
(void)	- setValue:forUndefinedKey:
(void)	- setValuesForKeysWithDictionary:
(CPString)	- UID
(void)	- unbind:
(Class)	- valueClassForBinding:
(id)	- valueForKeyPath:
(id)	- valueForUndefinedKey:
(void)	- willChange:valuesAtIndexes:forKey:
(void)	- willChangeValueForKey:
(void)	- willChangeValueForKey:withSetMutation:usingObjects:

Class Methods
(id)	+ alloc
(id)	+ dictionary
(id)	+ dictionaryWithDictionary:
(id)	+ dictionaryWithJSObject:
(id)	+ dictionaryWithJSObject:recursively:
(id)	+ dictionaryWithObject:forKey:
(id)	+ dictionaryWithObjects:forKeys:
(id)	+ dictionaryWithObjectsAndKeys:
Class Methods inherited from CPObject
(BOOL)	+ accessInstanceVariablesDirectly
(id)	+ allocWithCoder:
(BOOL)	+ automaticallyNotifiesObserversForKey:
(Class)	+ class
(void)	+ exposeBinding:
(void)	+ initialize
(IMP)	+ instanceMethodForSelector:
(BOOL)	+ instancesRespondToSelector:
(BOOL)	+ isSubclassOfClass:
(CPSet)	+ keyPathsForValuesAffectingValueForKey:
(void)	+ load
(id)	+ new
(void)	+ setVersion:
(Class)	+ superclass
(int)	+ version

Additional Inherited Members
Instance Variables inherited from CPObject
Class	isa

Detailed Description

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.

Method Documentation

- (void) addEntriesFromDictionary: (CPDictionary)  aDictionary

implementation

Take all the key/value pairs in aDictionary and apply them to this dictionary.

Definition at line 611 of file CPDictionary.j.

- (CPArray) allKeys

implementation

Returns an array of keys for all the entries in the dictionary.

Definition at line 327 of file CPDictionary.j.

- (CPArray) allKeysForObject: (id)  anObject

implementation

Returns a new array containing the keys corresponding to all occurrences of a given object in the receiver.

Parameters

anObject

The value to look for in the receiver.

Returns

A new array containing the keys corresponding to all occurrences of anObject in the receiver. If no object matching anObject is found, returns an empty array.

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 354 of file CPDictionary.j.

+ (id) alloc

implementation

Allocates a new instance of the receiving class

Reimplemented from CPObject.

Definition at line 82 of file CPDictionary.j.

- (CPArray) allValues

implementation

Returns an array of values for all the entries in the dictionary.

Definition at line 335 of file CPDictionary.j.

- (BOOL) containsKey: (id)  aKey

implementation

Definition at line 648 of file CPDictionary.j.

- (CPDictionary) copy

implementation

return a copy of the receiver (does not deep copy the objects contained in the dictionary).

Reimplemented from CPObject.

Definition at line 311 of file CPDictionary.j.

- (int) count

implementation

Returns the number of entries in the dictionary

Definition at line 319 of file CPDictionary.j.

- (CPString) description

implementation

Returns a human readable description of the dictionary.

Reimplemented from CPObject.

Definition at line 630 of file CPDictionary.j.

+ (id) dictionary

implementation

Returns a new empty CPDictionary.

Definition at line 92 of file CPDictionary.j.

+ (id) dictionaryWithDictionary: (CPDictionary)  aDictionary

implementation

Returns a new dictionary, initialized with the contents of aDictionary.

Parameters

aDictionary

the dictionary to copy key-value pairs from

Returns

the new CPDictionary

Definition at line 102 of file CPDictionary.j.

+ (id) dictionaryWithJSObject: (JSObject)  object

implementation

Creates a dictionary with multiple key-value pairs.

Parameters

JavaScript

object

Returns

the new CPDictionary

Definition at line 135 of file CPDictionary.j.

+ (id) dictionaryWithJSObject: (JSObject)  object recursively: (BOOL)  recursively

implementation

Creates a dictionary with multiple key-value pairs, recursively.

Parameters

JavaScript

object

Returns

the new CPDictionary

Definition at line 145 of file CPDictionary.j.

+ (id) dictionaryWithObject: (id)  anObject forKey: (id)  aKey

implementation

Creates a new dictionary with single key-value pair.

Parameters

anObject	the object for the paring
aKey	the key for the pairing

Returns

the new CPDictionary

Definition at line 113 of file CPDictionary.j.

+ (id) dictionaryWithObjects: (CPArray)  objects forKeys: (CPArray)  keys

implementation

Creates a dictionary with multiple key-value pairs.

Parameters

objects	the objects to place in the dictionary
keys	the keys for each of the objects

Exceptions

CPInvalidArgumentException

if the number of objects and keys is different

Returns

the new CPDictionary

Definition at line 125 of file CPDictionary.j.

+ (id) dictionaryWithObjectsAndKeys: (id)  firstObject ,   ...

implementation

Creates and returns a dictionary constructed by a given pairs of keys and values.

Parameters

firstObject	first object value
...	key for the first object and ongoing value-key pairs for more objects.

Exceptions

CPInvalidArgumentException

if the number of objects and keys is different

Returns

the new CPDictionary

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.

See also

[CPDictionary - initWithObjectsAndKeys:]

Definition at line 217 of file CPDictionary.j.

- (void) encodeWithCoder: (CPCoder)  aCoder

implementation

Archives the dictionary to a provided coder.

Parameters

aCoder

the coder to which the dictionary data will be archived.

Provided by category CPDictionary(CPCoding).

Definition at line 697 of file CPDictionary.j.

- (void) enumerateKeysAndObjectsUsingBlock: (Function /*(id aKey, id anObject, @ref BOOL stop)*/)  aFunction

implementation

Definition at line 654 of file CPDictionary.j.

- (void) enumerateKeysAndObjectsWithOptions: (CPEnumerationOptions)  opts usingBlock: (Function /*(id aKey, id anObject, @ref BOOL stop)*/)  aFunction

implementation

Definition at line 671 of file CPDictionary.j.

- (id) initWithCoder: (CPCoder)  aCoder

implementation

Provided by category CPDictionary(CPCoding).

Definition at line 688 of file CPDictionary.j.

- (id) initWithDictionary: (CPDictionary)  aDictionary

implementation

Initializes the dictionary with the contents of another dictionary.

Parameters

aDictionary

the dictionary to copy key-value pairs from

Returns

the initialized dictionary

Definition at line 230 of file CPDictionary.j.

- (id) initWithObjects: (CPArray)  objects forKeys: (CPArray)  keyArray

implementation

Initializes the dictionary from the arrays of keys and objects.

Parameters

objects	the objects to put in the dictionary
keyArray	the keys for the objects to put in the dictionary

Exceptions

CPInvalidArgumentException

if the number of objects and keys is different

Returns

the initialized dictionary

Definition at line 248 of file CPDictionary.j.

- (id) initWithObjectsAndKeys: (id)  firstObject ,   ...

implementation

Creates and returns a dictionary constructed by a given pairs of keys and values.

Parameters

firstObject	first object value
...	key for the first object and ongoing value-key pairs for more objects.

Exceptions

CPInvalidArgumentException

if the number of objects and keys is different

Returns

the new CPDictionary

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 280 of file CPDictionary.j.

- (CPDictionary) inverseChangeDictionary

implementation

Provided by category CPDictionary(KeyValueObserving).

Definition at line 222 of file CPKeyValueObserving.j.

- (BOOL) isEqual: (id)  anObject

implementation

Determines if anObject is functionally equivalent to the receiver.

Returns

YES if anObject is functionally equivalent to the receiver.

Reimplemented from CPObject.

Definition at line 490 of file CPDictionary.j.

- (BOOL) isEqualToDictionary: (CPDictionary)  aDictionary

implementation

Compare the receiver to this dictionary, and return whether or not they are equal.

Definition at line 460 of file CPDictionary.j.

- (CPEnumerator) keyEnumerator

implementation

Returns an enumerator that enumerates over all the dictionary's keys.

Definition at line 444 of file CPDictionary.j.

- (CPArray) keysOfEntriesPassingTest: (Function /*(id key, id obj, @ref BOOL stop)*/)  predicate

implementation

Definition at line 376 of file CPDictionary.j.

- (CPArray) keysOfEntriesWithOptions: (CPEnumerationOptions)  options passingTest: (Function /*(id key, id obj, @ref BOOL stop)*/)  predicate

implementation

Definition at line 381 of file CPDictionary.j.

- (CPArray) keysSortedByValueUsingComparator: (Function /*(id obj1, id obj2)*/)  comparator

implementation

Definition at line 417 of file CPDictionary.j.

- (CPArray) keysSortedByValueUsingSelector: (SEL)  theSelector

implementation

Definition at line 429 of file CPDictionary.j.

- (CPEnumerator) objectEnumerator

implementation

Returns an enumerator that enumerates over all the dictionary's values.

Definition at line 452 of file CPDictionary.j.

- (id) objectForKey: (id)  aKey

implementation

Returns the object for the entry with key aKey.

Parameters

aKey	the key for the object's entry

Returns

the object for the entry

Definition at line 529 of file CPDictionary.j.

- (void) removeAllObjects

implementation

Removes all the entries from the dictionary.

Definition at line 560 of file CPDictionary.j.

- (void) removeObjectForKey: (id)  aKey

implementation

Removes the entry for the specified key.

Parameters

aKey	the key of the entry to be removed

Definition at line 569 of file CPDictionary.j.

- (void) removeObjectsForKeys: (CPArray)  keysForRemoval

implementation

Removes each entry in allKeys from the receiver.

Parameters

allKeys

an array of keys that will be removed from the dictionary

Definition at line 578 of file CPDictionary.j.

- (void) setObject: (id)  anObject forKey: (id)  aKey

implementation

Adds an entry into the dictionary.

Parameters

anObject	the object for the entry
aKey	the entry's key

Definition at line 603 of file CPDictionary.j.

- (void) setValue: (id)  aValue forKey: (CPString)  aKey

implementation

Reimplemented from CPObject.

Provided by category CPDictionary(CPKeyValueCoding).

Definition at line 267 of file CPKeyValueCoding.j.

- (id) valueForKey: (CPString)  aKey

implementation

Reimplemented from CPObject.

Provided by category CPDictionary(CPKeyValueCoding).

Definition at line 259 of file CPKeyValueCoding.j.

---

The documentation for this class was generated from the following files:

• Foundation/CPDictionary.h
• Foundation/CPDictionary.j