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

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

#import <ObjFW/OFMapTable.h>

Inheritance diagram for OFMapTable:
OFObject <OFCopying> <OFFastEnumeration> <OFObject>

Instance Methods

(id) - initWithKeyFunctions:valueFunctions:
 Initializes an already allocated OFMapTable with the specified key and value functions. More...
 
(id) - initWithKeyFunctions:valueFunctions:capacity:
 Initializes an already allocated OFMapTable with the specified key functions, value functions and capacity. More...
 
(size_t) - count
 Returns the number of objects in the map table. More...
 
(nullable void *) - valueForKey:
 Returns the value for the given key or NULL if the key was not found. More...
 
(void) - setValue:forKey:
 Sets a value for a key. More...
 
(void) - removeValueForKey:
 Removes the value for the specified key from the map table. More...
 
(void) - removeAllValues
 Removes all values.
 
(bool) - containsValue:
 Checks whether the map table contains a value equal to the specified value. More...
 
(bool) - containsValueIdenticalTo:
 Checks whether the map table contains a value with the specified address. More...
 
(OFMapTableEnumerator *) - keyEnumerator
 Returns an OFMapTableEnumerator to enumerate through the map table's keys. More...
 
(OFMapTableEnumerator *) - valueEnumerator
 Returns an OFMapTableEnumerator to enumerate through the map table's values. More...
 
(void) - enumerateKeysAndValuesUsingBlock:
 Executes a block for each key / object pair. More...
 
(void) - replaceValuesUsingBlock:
 Replaces each value with the value returned by the block. More...
 
(of_map_table_functions_t- keyFunctions
 Returns the key functions used by the map table. More...
 
(of_map_table_functions_t- valueFunctions
 Returns the value functions used by the map table. 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 <OFFastEnumeration>
(int) - countByEnumeratingWithState:objects:count:
 A method which is called by the code produced by the compiler when doing a fast enumeration. More...
 

Class Methods

(instancetype) + mapTableWithKeyFunctions:valueFunctions:
 Creates a new OFMapTable with the specified key and value functions. More...
 
(instancetype) + mapTableWithKeyFunctions:valueFunctions:capacity:
 Creates a new OFMapTable with the specified key functions, value functions and capacity. 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

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

Method Documentation

- (bool) containsValue: (nullable void *)  value

Checks whether the map table contains a value equal to the specified value.

Parameters
valueThe value which is checked for being in the map table
Returns
A boolean whether the map table contains the specified value
- (bool) containsValueIdenticalTo: (nullable void *)  value

Checks whether the map table contains a value with the specified address.

Parameters
valueThe value which is checked for being in the map table
Returns
A boolean whether the map table contains a value with the specified address.
- (size_t) count

Returns the number of objects in the map table.

Returns
The number of objects in the map table
- (void) enumerateKeysAndValuesUsingBlock: (of_map_table_enumeration_block_t block

Executes a block for each key / object pair.

Parameters
blockThe block to execute for each key / object pair.
- (id) initWithKeyFunctions: (of_map_table_functions_t keyFunctions
valueFunctions: (of_map_table_functions_t valueFunctions 

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

Parameters
keyFunctionsA structure of functions for handling keys
valueFunctionsA structure of functions for handling values
Returns
An initialized OFMapTable
- (id) initWithKeyFunctions: (of_map_table_functions_t keyFunctions
valueFunctions: (of_map_table_functions_t valueFunctions
capacity: (size_t)  capacity 

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

Parameters
keyFunctionsA structure of functions for handling keys
valueFunctionsA structure of functions for handling values
capacityA hint about the count of elements expected to be in the map table
Returns
An initialized OFMapTable
- (OFMapTableEnumerator *) keyEnumerator

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

Returns
An OFMapTableEnumerator to enumerate through the map table's keys
- (of_map_table_functions_t) keyFunctions

Returns the key functions used by the map table.

Returns
The key functions used by the map table
+ (instancetype) mapTableWithKeyFunctions: (of_map_table_functions_t keyFunctions
valueFunctions: (of_map_table_functions_t valueFunctions 

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

Parameters
keyFunctionsA structure of functions for handling keys
valueFunctionsA structure of functions for handling values
Returns
A new autoreleased OFMapTable
+ (instancetype) mapTableWithKeyFunctions: (of_map_table_functions_t keyFunctions
valueFunctions: (of_map_table_functions_t valueFunctions
capacity: (size_t)  capacity 

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

Parameters
keyFunctionsA structure of functions for handling keys
valueFunctionsA structure of functions for handling values
capacityA hint about the count of elements expected to be in the map table
Returns
A new autoreleased OFMapTable
- (void) removeValueForKey: (void*)  key

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

Parameters
keyThe key whose object should be removed
- (void) replaceValuesUsingBlock: (of_map_table_replace_block_t block

Replaces each value with the value returned by the block.

Parameters
blockThe block which returns a new value for each value
- (void) setValue: (void*)  value
forKey: (void*)  key 

Sets a value for a key.

Parameters
keyThe key to set
valueThe value to set the key to
- (OFMapTableEnumerator *) valueEnumerator

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

Returns
An OFMapTableEnumerator to enumerate through the map table's values
- (void *) valueForKey: (void*)  key

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

Parameters
keyThe key whose object should be returned
Returns
The value for the given key or NULL if the key was not found
- (of_map_table_functions_t) valueFunctions

Returns the value functions used by the map table.

Returns
The value functions used by the map table

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