ObjFW
Instance Methods | Class Methods | List of all members
OFDictionary Class Reference

An abstract class for storing objects in a dictionary. More...

#import <ObjFW/OFDictionary.h>

Inheritance diagram for OFDictionary:
OFObject <OFCopying> <OFMutableCopying> <OFCollection> <OFSerialization> <OFJSONRepresentation> <OFMessagePackRepresentation> <OFObject> <OFEnumerating> <OFFastEnumeration> OFMutableDictionary

Instance Methods

(id) - initWithDictionary:
 Initializes an already allocated OFDictionary with the specified OFDictionary. More...
 
(id) - initWithObject:forKey:
 Initializes an already allocated OFDictionary with the specified key and object. More...
 
(id) - initWithObjects:forKeys:
 Initializes an already allocated OFDictionary with the specified keys and objects. More...
 
(id) - initWithObjects:forKeys:count:
 Initializes an already allocated OFDictionary with the specified keys and objects. More...
 
(id) - initWithKeysAndObjects:
 Initializes an already allocated OFDictionary with the specified keys and objects. More...
 
(id) - initWithKey:arguments:
 Initializes an already allocated OFDictionary with the specified key and va_list. More...
 
(nullable ObjectType) - objectForKey:
 Returns the object for the given key or nil if the key was not found. More...
 
(bool) - containsObject:
 Checks whether the dictionary contains an object equal to the specified object. More...
 
(bool) - containsObjectIdenticalTo:
 Checks whether the dictionary contains an object with the specified address. More...
 
(OFArray OF_GENERIC(KeyType) - allKeys
 Returns an array of all keys. More...
 
(OFArray OF_GENERIC(ObjectType) - allObjects
 Returns an array of all objects. More...
 
(OFEnumerator OF_GENERIC(KeyType) - keyEnumerator
 Returns an OFEnumerator to enumerate through the dictionary's keys. More...
 
(OFEnumerator OF_GENERIC(ObjectType) - objectEnumerator
 Returns an OFEnumerator to enumerate through the dictionary's objects. More...
 
(void) - enumerateKeysAndObjectsUsingBlock:
 Executes a block for each key / object pair. More...
 
(OFDictionary OF_GENERIC(KeyType, id) - mappedDictionaryUsingBlock:
 Creates a new dictionary, mapping each object using the specified block. More...
 
(OFDictionary OF_GENERIC(KeyType, ObjectType) - filteredDictionaryUsingBlock:
 Creates a new dictionary, only containing the objects for which the block returns true. More...
 
- Instance Methods inherited from OFObject
(id) - init
 Initializes an already allocated object. More...
 
(OFString *) - className
 Returns the name of the object's class. More...
 
(OFString *) - description
 Returns a description for the object. More...
 
(void *) - allocMemoryWithSize:
 Allocates memory and stores it in the object's memory pool. More...
 
(void *) - allocMemoryWithSize:count:
 Allocates memory for the specified number of items and stores it in the object's memory pool. More...
 
(nullable void *) - resizeMemory:size:
 Resizes memory in the object's memory pool to the specified size. More...
 
(nullable void *) - resizeMemory:size:count:
 Resizes memory in the object's memory pool to the specific number of items of the specified size. More...
 
(void) - freeMemory:
 Frees allocated memory and removes it from the object's memory pool. More...
 
(void) - dealloc
 Deallocates the object. More...
 
(void) - performSelector:afterDelay:
 Performs the specified selector after the specified delay. More...
 
(void) - performSelector:withObject:afterDelay:
 Performs the specified selector with the specified object after the specified delay. More...
 
(void) - performSelector:withObject:withObject:afterDelay:
 Performs the specified selector with the specified objects after the specified delay. More...
 
(void) - performSelector:onThread:waitUntilDone:
 Performs the specified selector on the specified thread. More...
 
(void) - performSelector:onThread:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified object. More...
 
(void) - performSelector:onThread:withObject:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified objects. More...
 
(void) - performSelectorOnMainThread:waitUntilDone:
 Performs the specified selector on the main thread. More...
 
(void) - performSelectorOnMainThread:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified object. More...
 
(void) - performSelectorOnMainThread:withObject:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified objects. More...
 
(void) - performSelector:onThread:afterDelay:
 Performs the specified selector on the specified thread after the specified delay. More...
 
(void) - performSelector:onThread:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified object after the specified delay. More...
 
(void) - performSelector:onThread:withObject:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified objects after the specified delay. More...
 
(nullable id) - forwardingTargetForSelector:
 This method is called when resolveClassMethod: or resolveInstanceMethod: returned false. It should return a target to which the message should be forwarded. More...
 
(void) - doesNotRecognizeSelector:
 Handles messages which are not understood by the receiver. More...
 
(OFString *) - stringBySerializing
 Creates a string by serializing the receiver. More...
 
- Instance Methods inherited from <OFObject>
(bool) - isKindOfClass:
 Returns a boolean whether the object of the specified kind. More...
 
(bool) - isMemberOfClass:
 Returns a boolean whether the object is a member of the specified class. More...
 
(bool) - respondsToSelector:
 Returns a boolean whether the object responds to the specified selector. More...
 
(nullable IMP) - methodForSelector:
 Returns the implementation for the specified selector. More...
 
(nullable const char *) - typeEncodingForSelector:
 Returns the type encoding for the specified selector. More...
 
(nullable id) - performSelector:
 Performs the specified selector. More...
 
(nullable id) - performSelector:withObject:
 Performs the specified selector with the specified object. More...
 
(nullable id) - performSelector:withObject:withObject:
 Performs the specified selector with the specified objects. More...
 
(bool) - isEqual:
 Checks two objects for equality. More...
 
(uint32_t) - hash
 Calculates a hash for the object. More...
 
(id) - retain
 Increases the retain count. More...
 
(unsigned int) - retainCount
 Returns the retain count. More...
 
(void) - release
 Decreases the retain count. More...
 
(id) - autorelease
 Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack. More...
 
(id) - self
 Returns the receiver. More...
 
(bool) - isProxy
 Returns whether the object is a proxy object. More...
 
- Instance Methods inherited from <OFCopying>
(id) - copy
 Copies the object. More...
 
- Instance Methods inherited from <OFMutableCopying>
(id) - mutableCopy
 Creates a mutable copy of the object. More...
 
- Instance Methods inherited from <OFCollection>
(size_t) - count
 Returns the number of objects in the collection. More...
 
(bool) - containsObject:
 Checks whether the collection contains an object equal to the specified object. More...
 
- Instance Methods inherited from <OFFastEnumeration>
(int) - countByEnumeratingWithState:objects:count:
 A method which is called by the code produced by the compiler when doing a fast enumeration. More...
 
- Instance Methods inherited from <OFSerialization>
(id) - initWithSerialization:
 Initializes the object with the specified XML element serialization. More...
 
(OFXMLElement *) - XMLElementBySerializing
 Serializes the object into an XML element. More...
 
- Instance Methods inherited from <OFJSONRepresentation>
(OFString *) - JSONRepresentation
 Returns the JSON representation of the object as a string. More...
 
(OFString *) - JSONRepresentationWithOptions:
 Returns the JSON representation of the object as a string. More...
 
- Instance Methods inherited from <OFMessagePackRepresentation>
(OFDataArray *) - messagePackRepresentation
 Returns the MessagePack representation of the object as an OFDataArray. More...
 

Class Methods

(instancetype) + dictionary
 Creates a new OFDictionary. More...
 
(instancetype) + dictionaryWithDictionary:
 Creates a new OFDictionary with the specified dictionary. More...
 
(instancetype) + dictionaryWithObject:forKey:
 Creates a new OFDictionary with the specified key and object. More...
 
(instancetype) + dictionaryWithObjects:forKeys:
 Creates a new OFDictionary with the specified keys and objects. More...
 
(instancetype) + dictionaryWithObjects:forKeys:count:
 Creates a new OFDictionary with the specified keys and objects. More...
 
(instancetype) + dictionaryWithKeysAndObjects:
 Creates a new OFDictionary with the specified keys objects. More...
 
- Class Methods inherited from OFObject
(void) + load
 A method which is called once when the class is loaded into the runtime. More...
 
(void) + unload
 A method which is called when the class is unloaded from the runtime. More...
 
(void) + initialize
 A method which is called the moment before the first call to the class is being made. More...
 
(id) + alloc
 Allocates memory for an instance of the class and sets up the memory pool for the object. More...
 
(id) + new
 Allocates memory for a new instance and calls init on it. More...
 
(Class) + class
 Returns the class. More...
 
(OFString *) + className
 Returns the name of the class as a string. More...
 
(bool) + isSubclassOfClass:
 Returns a boolean whether the class is a subclass of the specified class. More...
 
(Class) + superclass
 Returns the superclass of the class. More...
 
(bool) + instancesRespondToSelector:
 Checks whether instances of the class respond to a given selector. More...
 
(bool) + conformsToProtocol:
 Checks whether the class conforms to a given protocol. More...
 
(nullable IMP) + instanceMethodForSelector:
 Returns the implementation of the instance method for the specified selector. More...
 
(nullable const char *) + typeEncodingForInstanceSelector:
 Returns the type encoding of the instance method for the specified selector. More...
 
(OFString *) + description
 Returns a description for the class, which is usually the class name. More...
 
(nullable IMP) + replaceClassMethod:withMethodFromClass:
 Replaces a class method with a class method from another class. More...
 
(nullable IMP) + replaceInstanceMethod:withMethodFromClass:
 Replaces an instance method with an instance method from another class. More...
 
(nullable IMP) + replaceClassMethod:withImplementation:typeEncoding:
 Replaces or adds a class method. More...
 
(nullable IMP) + replaceInstanceMethod:withImplementation:typeEncoding:
 Replaces or adds an instance method. More...
 
(void) + inheritMethodsFromClass:
 Adds all methods from the specified class to the class that is the receiver. More...
 
(bool) + resolveClassMethod:
 Try to resolve the specified class method. More...
 
(bool) + resolveInstanceMethod:
 Try to resolve the specified instance method. More...
 
(id) + copy
 Returns the class. More...
 

Detailed Description

An abstract class for storing objects in a dictionary.

Keys are copied and thus must conform to the OFCopying protocol.

Note
Fast enumeration on a dictionary enumerates through the keys of the dictionary.

Method Documentation

- (OFArray *) allKeys

Returns an array of all keys.

Returns
An array of all keys
- (OFArray *) allObjects

Returns an array of all objects.

Returns
An array of all objects
- (bool) containsObject: (nullable ObjectType)  object

Checks whether the dictionary contains an object equal to the specified object.

Parameters
objectThe object which is checked for being in the dictionary
Returns
A boolean whether the dictionary contains the specified object
- (bool) containsObjectIdenticalTo: (nullable ObjectType)  object

Checks whether the dictionary contains an object with the specified address.

Parameters
objectThe object which is checked for being in the dictionary
Returns
A boolean whether the dictionary contains an object with the specified address
+ (instancetype) dictionary

Creates a new OFDictionary.

Returns
A new autoreleased OFDictionary
+ (instancetype) dictionaryWithDictionary: (OFDictionary OF_GENERIC(KeyType, ObjectType)*)  dictionary

Creates a new OFDictionary with the specified dictionary.

Parameters
dictionaryAn OFDictionary
Returns
A new autoreleased OFDictionary
+ (instancetype) dictionaryWithKeysAndObjects: (KeyType)  firstKey
,   ... 

Creates a new OFDictionary with the specified keys objects.

Parameters
firstKeyThe first key
Returns
A new autoreleased OFDictionary
+ (instancetype) dictionaryWithObject: (ObjectType)  object
forKey: (KeyType)  key 

Creates a new OFDictionary with the specified key and object.

Parameters
keyThe key
objectThe object
Returns
A new autoreleased OFDictionary
+ (instancetype) dictionaryWithObjects: (OFArray OF_GENERIC(ObjectType)*)  objects
forKeys: (OFArray OF_GENERIC(KeyType)*)  keys 

Creates a new OFDictionary with the specified keys and objects.

Parameters
keysAn array of keys
objectsAn array of objects
Returns
A new autoreleased OFDictionary
+ (instancetype) dictionaryWithObjects: (ObjectType const OF_NONNULL *OF_NONNULL)  objects
forKeys: (KeyType const OF_NONNULL *OF_NONNULL)  keys
count: (size_t)  count 

Creates a new OFDictionary with the specified keys and objects.

Parameters
keysAn array of keys
objectsAn array of objects
countThe number of objects in the arrays
Returns
A new autoreleased OFDictionary
- (void) enumerateKeysAndObjectsUsingBlock: (of_dictionary_enumeration_block_t)  block

Executes a block for each key / object pair.

Parameters
blockThe block to execute for each key / object pair.
- (OFDictionary *) filteredDictionaryUsingBlock: (of_dictionary_filter_block_t)  block

Creates a new dictionary, only containing the objects for which the block returns true.

Parameters
blockA block which determines if the object should be in the new dictionary
Returns
A new autoreleased OFDictionary
- (id) initWithDictionary: (OFDictionary OF_GENERIC(KeyType, ObjectType)*)  dictionary

Initializes an already allocated OFDictionary with the specified OFDictionary.

Parameters
dictionaryAn OFDictionary
Returns
An initialized OFDictionary
- (id) initWithKey: (KeyType)  firstKey
arguments: (va_list)  arguments 

Initializes an already allocated OFDictionary with the specified key and va_list.

Parameters
firstKeyThe first key
argumentsA va_list of the other arguments
Returns
An initialized OFDictionary
- (id) initWithKeysAndObjects: (KeyType)  firstKey
,   ... 

Initializes an already allocated OFDictionary with the specified keys and objects.

Parameters
firstKeyThe first key
Returns
An initialized OFDictionary
- (id) initWithObject: (ObjectType)  object
forKey: (KeyType)  key 

Initializes an already allocated OFDictionary with the specified key and object.

Parameters
keyThe key
objectThe object
Returns
An initialized OFDictionary
- (id) initWithObjects: (OFArray OF_GENERIC(ObjectType)*)  objects
forKeys: (OFArray OF_GENERIC(KeyType)*)  keys 

Initializes an already allocated OFDictionary with the specified keys and objects.

Parameters
keysAn array of keys
objectsAn array of objects
Returns
An initialized OFDictionary
- (id) initWithObjects: (ObjectType const OF_NONNULL *OF_NONNULL)  objects
forKeys: (KeyType const OF_NONNULL *OF_NONNULL)  keys
count: (size_t)  count 

Initializes an already allocated OFDictionary with the specified keys and objects.

Parameters
keysAn array of keys
objectsAn array of objects
countThe number of objects in the arrays
Returns
An initialized OFDictionary
- (OFEnumerator *) keyEnumerator

Returns an OFEnumerator to enumerate through the dictionary's keys.

Returns
An OFEnumerator to enumerate through the dictionary's keys
- (OFDictionary *) mappedDictionaryUsingBlock: (of_dictionary_map_block_t)  block

Creates a new dictionary, mapping each object using the specified block.

Parameters
blockA block which maps an object for each object
Returns
A new autoreleased OFDictionary
- (OFEnumerator *) objectEnumerator

Returns an OFEnumerator to enumerate through the dictionary's objects.

Returns
An OFEnumerator to enumerate through the dictionary's objects

Reimplemented from <OFEnumerating>.

- (nullable ObjectType) objectForKey: (KeyType)  key

Returns the object for the given key or nil if the key was not found.

Warning
The returned object is not retained and autoreleased for performance reasons!
Parameters
keyThe key whose object should be returned
Returns
The object for the given key or nil if the key was not found

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