A class similar to OFDictionary, but providing more options how keys and objects should be retained, released, compared and hashed. More...

#include <ObjFW/OFMapTable.h>

Inheritance diagram for OFMapTable:

Instance Methods
(instancetype)	- initWithKeyFunctions:objectFunctions:
	Initializes an already allocated OFMapTable with the specified key and object functions.

(instancetype)	- initWithKeyFunctions:objectFunctions:capacity:
	Initializes an already allocated OFMapTable with the specified key functions, object functions and capacity.

(nullable void *)	- objectForKey:
	Returns the object for the given key or NULL if the key was not found.

(void)	- setObject:forKey:
	Sets an object for a key.

(void)	- removeObjectForKey:
	Removes the object for the specified key from the map table.

(void)	- removeAllObjects
	Removes all objects.

(bool)	- containsObject:
	Checks whether the map table contains an object equal to the specified object.

(bool)	- containsObjectIdenticalTo:
	Checks whether the map table contains an object with the specified address.

(OFMapTableEnumerator *)	- keyEnumerator
	Returns an OFMapTableEnumerator to enumerate through the map table's keys.

(OFMapTableEnumerator *)	- objectEnumerator
	Returns an OFMapTableEnumerator to enumerate through the map table's objects.

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

(void)	- replaceObjectsUsingBlock:
	Replaces each object with the object returned by the block.

Instance Methods inherited from OFObject
(instancetype)	- init
	Initializes an already allocated object.

(nullable OFMethodSignature *)	- methodSignatureForSelector:
	Returns the method signature for the specified selector.

(void)	- dealloc
	Deallocates the object.

(void)	- performSelector:afterDelay:
	Performs the specified selector after the specified delay.

(void)	- performSelector:withObject:afterDelay:
	Performs the specified selector with the specified object after the specified delay.

(void)	- performSelector:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.

(void)	- performSelector:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.

(void)	- performSelector:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.

(void)	- performSelector:onThread:waitUntilDone:
	Performs the specified selector on the specified thread.

(void)	- performSelector:onThread:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified object.

(void)	- performSelector:onThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.

(void)	- performSelector:onThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.

(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.

(void)	- performSelectorOnMainThread:waitUntilDone:
	Performs the specified selector on the main thread.

(void)	- performSelectorOnMainThread:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified object.

(void)	- performSelectorOnMainThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.

(void)	- performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.

(void)	- performSelectorOnMainThread:withObject:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.

(void)	- performSelector:onThread:afterDelay:
	Performs the specified selector on the specified thread after the specified delay.

(void)	- performSelector:onThread:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified object after the specified delay.

(void)	- performSelector:onThread:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.

(void)	- performSelector:onThread:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.

(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.

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

(void)	- doesNotRecognizeSelector:
	Handles messages which are not understood by the receiver.

Instance Methods inherited from <OFObject>
(unsigned long)	- hash
	Returns a hash for the object.

(unsigned int)	- retainCount
	Returns the retain count.

(bool)	- isProxy
	Returns whether the object is a proxy object.

(bool)	- isKindOfClass:
	Returns a boolean whether the object is of the specified kind.

(bool)	- isMemberOfClass:
	Returns a boolean whether the object is a member of the specified class.

(bool)	- respondsToSelector:
	Returns a boolean whether the object responds to the specified selector.

(nullable IMP)	- methodForSelector:
	Returns the implementation for the specified selector.

(nullable id)	- performSelector:
	Performs the specified selector.

(nullable id)	- performSelector:withObject:
	Performs the specified selector with the specified object.

(nullable id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects.

(nullable id)	- performSelector:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.

(nullable id)	- performSelector:withObject:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.

(bool)	- isEqual:
	Checks two objects for equality.

(instancetype)	- retain
	Increases the retain count.

(void)	- release
	Decreases the retain count.

(instancetype)	- autorelease
	Adds the object to the topmost autorelease pool of the thread's autorelease pool stack.

(instancetype)	- self
	Returns the receiver.

(bool)	- allowsWeakReference
	Returns whether the object allows a weak reference.

(bool)	- retainWeakReference
	Retain a weak reference to this object.

Instance Methods inherited from <OFCopying>
(id)	- copy
	Copies the object.

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.

Class Methods
(instancetype)	+ mapTableWithKeyFunctions:objectFunctions:
	Creates a new OFMapTable with the specified key and object functions.

(instancetype)	+ mapTableWithKeyFunctions:objectFunctions:capacity:
	Creates a new OFMapTable with the specified key functions, object functions and capacity.

Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime.

(void)	+ unload
	A method which is called when the class is unloaded from the runtime.

(void)	+ initialize
	A method which is called the moment before the first call to the class is being made.

(instancetype)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object.

(Class)	+ class
	Returns the class.

(OFString *)	+ className
	Returns the name of the class as a string.

(bool)	+ isSubclassOfClass:
	Returns a boolean whether the class is a subclass of the specified class.

(nullable Class)	+ superclass
	Returns the superclass of the class.

(bool)	+ instancesRespondToSelector:
	Checks whether instances of the class respond to a given selector.

(bool)	+ conformsToProtocol:
	Checks whether the class conforms to a given protocol.

(nullable IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector.

(nullable OFMethodSignature *)	+ instanceMethodSignatureForSelector:
	Returns the method signature of the instance method for the specified selector.

(OFString *)	+ description
	Returns a description for the class, which is usually the class name.

(nullable IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class.

(nullable IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class.

(void)	+ inheritMethodsFromClass:
	Adds all methods from the specified class to the class that is the receiver.

(bool)	+ resolveClassMethod:
	Try to resolve the specified class method.

(bool)	+ resolveInstanceMethod:
	Try to resolve the specified instance method.

(id)	+ copy
	Returns the class.

Properties
OFMapTableFunctions	keyFunctions
	The key functions used by the map table.

OFMapTableFunctions	objectFunctions
	The object functions used by the map table.

size_t	count
	The number of objects in the map table.

Properties inherited from OFObject
OFString *	className
	The name of the object's class.

OFString *	description
	A description for the object.

Detailed Description

A class similar to OFDictionary, but providing more options how keys and objects should be retained, released, compared and hashed.

Method Documentation

◆ containsObject:

- (bool) containsObject: (nullable void *) object

Checks whether the map table contains an object equal to the specified object.

Parameters

object The object which is checked for being in the map table

Returns: A boolean whether the map table contains the specified object

◆ containsObjectIdenticalTo:

- (bool) containsObjectIdenticalTo: (nullable void *) object

Checks whether the map table contains an object with the specified address.

Parameters

object The object which is checked for being in the map table

Returns: A boolean whether the map table contains an object with the specified address.

◆ enumerateKeysAndObjectsUsingBlock:

- (void) enumerateKeysAndObjectsUsingBlock: (OFMapTableEnumerationBlock) block

Executes a block for each key / object pair.

Parameters

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

◆ initWithKeyFunctions:objectFunctions:

- (instancetype) initWithKeyFunctions:		(OFMapTableFunctions)	keyFunctions
objectFunctions:		(OFMapTableFunctions)	objectFunctions

Initializes an already allocated OFMapTable with the specified key and object functions.

Parameters

keyFunctions	A structure of functions for handling keys
objectFunctions	A structure of functions for handling objects

Returns: An initialized OFMapTable

◆ initWithKeyFunctions:objectFunctions:capacity:

- (instancetype) initWithKeyFunctions:	(OFMapTableFunctions)	keyFunctions
objectFunctions:	(OFMapTableFunctions)	objectFunctions
capacity:	(size_t)	capacity

Initializes an already allocated OFMapTable with the specified key functions, object functions and capacity.

Parameters

keyFunctions	A structure of functions for handling keys
objectFunctions	A structure of functions for handling objects
capacity	A hint about the count of elements expected to be in the map table

Returns: An initialized OFMapTable

◆ keyEnumerator

- (OFMapTableEnumerator *) keyEnumerator

Returns an OFMapTableEnumerator to enumerate through the map table's keys.

Returns: An OFMapTableEnumerator to enumerate through the map table's keys

◆ mapTableWithKeyFunctions:objectFunctions:

+ (instancetype) mapTableWithKeyFunctions:		(OFMapTableFunctions)	keyFunctions
objectFunctions:		(OFMapTableFunctions)	objectFunctions

Creates a new OFMapTable with the specified key and object functions.

Parameters

keyFunctions	A structure of functions for handling keys
objectFunctions	A structure of functions for handling objects

Returns: A new autoreleased OFMapTable

◆ mapTableWithKeyFunctions:objectFunctions:capacity:

+ (instancetype) mapTableWithKeyFunctions:	(OFMapTableFunctions)	keyFunctions
objectFunctions:	(OFMapTableFunctions)	objectFunctions
capacity:	(size_t)	capacity

Creates a new OFMapTable with the specified key functions, object functions and capacity.

Parameters

keyFunctions	A structure of functions for handling keys
objectFunctions	A structure of functions for handling objects
capacity	A hint about the count of elements expected to be in the map table

Returns: A new autoreleased OFMapTable

◆ objectEnumerator

- (OFMapTableEnumerator *) objectEnumerator

Returns an OFMapTableEnumerator to enumerate through the map table's objects.

Returns: An OFMapTableEnumerator to enumerate through the map table's objects

◆ objectForKey:

- (void *) objectForKey: (void *) key

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

Parameters

key	The key whose object should be returned

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

◆ removeObjectForKey:

- (void) removeObjectForKey: (nullable void *) key

Removes the object for the specified key from the map table.

Parameters

key	The key whose object should be removed

◆ replaceObjectsUsingBlock:

- (void) replaceObjectsUsingBlock: (OFMapTableReplaceBlock) block

Replaces each object with the object returned by the block.

Parameters

block The block which returns a new object for each object

◆ setObject:forKey:

- (void) setObject:		(nullable void *)	object
forKey:		(nullable void *)	key

Sets an object for a key.

Parameters

key	The key to set
object	The object to set the key to

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

src/OFMapTable.h
src/OFMapTable.m

Instance Methods

Class Methods

Properties

Detailed Description

Method Documentation

◆ containsObject:

◆ containsObjectIdenticalTo:

◆ enumerateKeysAndObjectsUsingBlock:

◆ initWithKeyFunctions:objectFunctions:

◆ initWithKeyFunctions:objectFunctions:capacity:

◆ keyEnumerator

◆ mapTableWithKeyFunctions:objectFunctions:

◆ mapTableWithKeyFunctions:objectFunctions:capacity:

◆ objectEnumerator

◆ objectForKey:

◆ removeObjectForKey:

◆ replaceObjectsUsingBlock:

◆ setObject:forKey: