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

#import <ObjFW/OFDictionary.h>

Inheritance diagram for OFDictionary:

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...

(nullable id)	- valueForKey:
	Returns the value for the given key or `nil` if the key was not found. More...

(void)	- setValue:forKey:
	Sets a value for a key. 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 *)	- allKeys
	Returns an array of all keys. More...

(OFArray *)	- allObjects
	Returns an array of all objects. More...

(OFString *)	- stringByURLEncoding
	Creates a string by URL-encoding the contents of the dictionary. More...

(OFEnumerator *)	- keyEnumerator
	Returns an OFEnumerator to enumerate through the dictionary's keys. More...

(OFEnumerator *)	- objectEnumerator
	Returns an OFEnumerator to enumerate through the dictionary's objects. More...

(void)	- enumerateKeysAndObjectsUsingBlock:
	Executes a block for each key / object pair. More...

(OFDictionary *)	- mappedDictionaryUsingBlock:
	Creates a new dictionary, mapping each object using the specified block. More...

(OFDictionary *)	- 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...

(nullable void *)	- allocMemoryWithSize:
	Allocates memory and stores it in the object's memory pool. More...

(nullable 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...

(bool)	- allowsWeakReference
	Returns whether the class allows weak references. More...

(bool)	- retainWeakReference
	Retain a weak reference to this 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 <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>
(OFData *)	- messagePackRepresentation
	Returns the MessagePack representation of the object as OFData. 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...

(nullable 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

◆ allKeys()

- (OFArray *) allKeys

Returns an array of all keys.

Returns: An array of all keys

◆ allObjects()

- (OFArray *) allObjects

Returns an array of all objects.

Returns: An array of all objects

◆ containsObject:()

- (bool) containsObject: (ObjectType) object

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

Parameters

object The object which is checked for being in the dictionary

Returns: A boolean whether the dictionary contains the specified object

◆ containsObjectIdenticalTo:()

- (bool) containsObjectIdenticalTo: (ObjectType) object

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

Parameters

object The object which is checked for being in the dictionary

Returns: A boolean whether the dictionary contains an object with the specified address

◆ dictionary()

+ (instancetype) dictionary

Creates a new OFDictionary.

Returns: A new autoreleased OFDictionary

◆ dictionaryWithDictionary:()

+ (instancetype) dictionaryWithDictionary: (OFDictionary *) dictionary

Creates a new OFDictionary with the specified dictionary.

Parameters

dictionary An OFDictionary

Returns: A new autoreleased OFDictionary

◆ dictionaryWithKeysAndObjects:()

+ (instancetype) dictionaryWithKeysAndObjects:	(KeyType)	firstKey
,		...

Creates a new OFDictionary with the specified keys objects.

Parameters

firstKey The first key

Returns: A new autoreleased OFDictionary

◆ dictionaryWithObject:forKey:()

+ (instancetype) dictionaryWithObject:	(ObjectType)	object
forKey:	(KeyType)	key

Creates a new OFDictionary with the specified key and object.

Parameters

key	The key
object	The object

Returns: A new autoreleased OFDictionary

◆ dictionaryWithObjects:forKeys:()

+ (instancetype) dictionaryWithObjects:	(OFArray *)	objects
forKeys:	(OFArray *)	keys

Creates a new OFDictionary with the specified keys and objects.

Parameters

keys	An array of keys
objects	An array of objects

Returns: A new autoreleased OFDictionary

◆ dictionaryWithObjects:forKeys:count:()

+ (instancetype) dictionaryWithObjects:	(ObjectType const _Nonnull *_Nonnull)	objects
forKeys:	(KeyType const _Nonnull *_Nonnull)	keys
count:	(size_t)	count

Creates a new OFDictionary with the specified keys and objects.

Parameters

keys	An array of keys
objects	An array of objects
count	The number of objects in the arrays

Returns: A new autoreleased OFDictionary

◆ enumerateKeysAndObjectsUsingBlock:()

- (void) enumerateKeysAndObjectsUsingBlock: (of_dictionary_enumeration_block_t) block

Executes a block for each key / object pair.

Parameters

block The block to execute for each key / object pair.

◆ filteredDictionaryUsingBlock:()

- (OFDictionary *) filteredDictionaryUsingBlock: (of_dictionary_filter_block_t) block

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

Parameters

block A block which determines if the object should be in the new dictionary

Returns: A new autoreleased OFDictionary

◆ initWithDictionary:()

- (id) initWithDictionary: (OFDictionary *) dictionary

Initializes an already allocated OFDictionary with the specified OFDictionary.

Parameters

dictionary An OFDictionary

Returns: An initialized OFDictionary

◆ initWithKey:arguments:()

- (id) initWithKey:	(KeyType)	firstKey
arguments:	(va_list)	arguments

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

Parameters

firstKey	The first key
arguments	A va_list of the other arguments

Returns: An initialized OFDictionary

◆ initWithKeysAndObjects:()

- (id) initWithKeysAndObjects:	(KeyType)	firstKey
,		...

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

Parameters

firstKey The first key

Returns: An initialized OFDictionary

◆ initWithObject:forKey:()

- (id) initWithObject:	(ObjectType)	object
forKey:	(KeyType)	key

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

Parameters

key	The key
object	The object

Returns: An initialized OFDictionary

◆ initWithObjects:forKeys:()

- (id) initWithObjects:	(OFArray *)	objects
forKeys:	(OFArray *)	keys

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

Parameters

keys	An array of keys
objects	An array of objects

Returns: An initialized OFDictionary

◆ initWithObjects:forKeys:count:()

- (id) initWithObjects:	(ObjectType const _Nonnull *_Nonnull)	objects
forKeys:	(KeyType const _Nonnull *_Nonnull)	keys
count:	(size_t)	count

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

Parameters

keys	An array of keys
objects	An array of objects
count	The number of objects in the arrays

Returns: An initialized OFDictionary

◆ keyEnumerator()

- (OFEnumerator *) keyEnumerator

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

Returns: An OFEnumerator to enumerate through the dictionary's keys

◆ mappedDictionaryUsingBlock:()

- (OFDictionary *) mappedDictionaryUsingBlock: (of_dictionary_map_block_t) block

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

Parameters

block A block which maps an object for each object

Returns: A new autoreleased OFDictionary

◆ objectEnumerator()

- (OFEnumerator *) objectEnumerator

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

Returns: An OFEnumerator to enumerate through the dictionary's objects

◆ objectForKey:()

- (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

key	The key whose object should be returned

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

◆ setValue:forKey:()

- (void) setValue:	(id)	value
forKey:	(OFString *)	key

Sets a value for a key.

If the key starts with an @, the @ is stripped and [super setValue:forKey:] is called. If the key does not start with an @, this is equivalent to setObject:forKey:. In this case, if the dictionary is immutable, an OFUndefinedKeyException is thrown.

Parameters

key	The key to set
value	The value to set the key to

◆ stringByURLEncoding()

- (OFString *) stringByURLEncoding

Creates a string by URL-encoding the contents of the dictionary.

Returns: A URL-encoded string with the contents of the dictionary

◆ valueForKey:()

- (id) valueForKey: (OFString *) key

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

If the key starts with an @, the @ is stripped and [super valueForKey:] is called. If the key does not start with an @, this is equivalent to objectForKey:.

Parameters

key	The key whose value should be returned

Returns: The value for the given key or nil if the key was not found

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

src/OFDictionary.h
src/OFDictionary.m

Instance Methods

Class Methods

Detailed Description

Method Documentation

◆ allKeys()

◆ allObjects()

◆ containsObject:()

◆ containsObjectIdenticalTo:()

◆ dictionary()

◆ dictionaryWithDictionary:()

◆ dictionaryWithKeysAndObjects:()

◆ dictionaryWithObject:forKey:()

◆ dictionaryWithObjects:forKeys:()

◆ dictionaryWithObjects:forKeys:count:()

◆ enumerateKeysAndObjectsUsingBlock:()

◆ filteredDictionaryUsingBlock:()

◆ initWithDictionary:()

◆ initWithKey:arguments:()

◆ initWithKeysAndObjects:()

◆ initWithObject:forKey:()

◆ initWithObjects:forKeys:()

◆ initWithObjects:forKeys:count:()

◆ keyEnumerator()

◆ mappedDictionaryUsingBlock:()

◆ objectEnumerator()

◆ objectForKey:()

◆ setValue:forKey:()

◆ stringByURLEncoding()

◆ valueForKey:()