ObjFW
|
An abstract class for storing and changing objects in a dictionary. More...
#include <ObjFW/ObjFW.h>
Instance Methods | |
(instancetype) | - init |
Initializes an already allocated OFMutableDictionary to be empty. | |
(instancetype) | - initWithCapacity: |
Initializes an already allocated OFMutableDictionary with enough memory to hold the specified number of objects. | |
(void) | - setObject:forKey: |
Sets an object for a key. | |
(void) | - setObject:forKeyedSubscript: |
Sets an object for a key. | |
(void) | - removeObjectForKey: |
Removes the object for the specified key from the dictionary. | |
(void) | - removeAllObjects |
Removes all objects. | |
(void) | - addEntriesFromDictionary: |
Adds the entries from the specified dictionary. | |
(void) | - replaceObjectsUsingBlock: |
Replaces each object with the object returned by the block. | |
(void) | - makeImmutable |
Converts the mutable dictionary to an immutable dictionary. | |
Instance Methods inherited from OFDictionary | |
(instancetype) | - initWithDictionary: |
Initializes an already allocated OFDictionary with the specified OFDictionary. | |
(instancetype) | - initWithObject:forKey: |
Initializes an already allocated OFDictionary with the specified key and object. | |
(instancetype) | - initWithObjects:forKeys: |
Initializes an already allocated OFDictionary with the specified keys and objects. | |
(instancetype) | - initWithObjects:forKeys:count: |
Initializes an already allocated OFDictionary with the specified keys and objects. | |
(instancetype) | - initWithKeysAndObjects: |
Initializes an already allocated OFDictionary with the specified keys and objects. | |
(instancetype) | - initWithKey:arguments: |
Initializes an already allocated OFDictionary with the specified key and va_list. | |
(nullable ObjectType) | - objectForKey: |
Returns the object for the given key or nil if the key was not found. | |
(nullable id) | - valueForKey: |
Returns the value for the given key or nil if the key was not found. | |
(void) | - setValue:forKey: |
Sets a value for a key. | |
(bool) | - containsObject: |
Checks whether the dictionary contains an object equal to the specified object. | |
(bool) | - containsObjectIdenticalTo: |
Checks whether the dictionary contains an object with the specified address. | |
(OFEnumerator *) | - keyEnumerator |
Returns an OFEnumerator to enumerate through the dictionary's keys. | |
(OFEnumerator *) | - objectEnumerator |
Returns an OFEnumerator to enumerate through the dictionary's objects. | |
(void) | - enumerateKeysAndObjectsUsingBlock: |
Executes a block for each key / object pair. | |
(OFDictionary *) | - mappedDictionaryUsingBlock: |
Creates a new dictionary, mapping each object using the specified block. | |
(OFDictionary *) | - filteredDictionaryUsingBlock: |
Creates a new dictionary, only containing the objects for which the block returns true. | |
Instance Methods inherited from OFObject | |
(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 <OFMutableCopying> | |
(id) | - mutableCopy |
Creates a mutable copy of the object. | |
Instance Methods inherited from <OFCollection> | |
(bool) | - containsObject: |
Checks whether the collection contains an object equal to the specified object. | |
Instance Methods inherited from <OFEnumeration> | |
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. | |
Instance Methods inherited from <OFJSONRepresentation> | |
(OFString *) | - JSONRepresentationWithOptions: |
Returns the JSON representation of the object as a string. | |
Class Methods | |
(instancetype) | + dictionaryWithCapacity: |
Creates a new OFMutableDictionary with enough memory to hold the specified number of objects. | |
Class Methods inherited from OFDictionary | |
(instancetype) | + dictionary |
Creates a new OFDictionary. | |
(instancetype) | + dictionaryWithDictionary: |
Creates a new OFDictionary with the specified dictionary. | |
(instancetype) | + dictionaryWithObject:forKey: |
Creates a new OFDictionary with the specified key and object. | |
(instancetype) | + dictionaryWithObjects:forKeys: |
Creates a new OFDictionary with the specified keys and objects. | |
(instancetype) | + dictionaryWithObjects:forKeys:count: |
Creates a new OFDictionary with the specified keys and objects. | |
(instancetype) | + dictionaryWithKeysAndObjects: |
Creates a new OFDictionary with the specified keys objects. | |
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. | |
Additional Inherited Members | |
Properties inherited from OFDictionary | |
OFArray * | allKeys |
An array of all keys. | |
OFArray * | allObjects |
An array of all objects. | |
unsigned long long | fileSize |
The OFFileSize key from the dictionary. | |
OFFileAttributeType | fileType |
The OFFileType key from the dictionary. | |
unsigned long | filePOSIXPermissions |
The OFFilePOSIXPermissions key from the dictionary. | |
unsigned long | fileOwnerAccountID |
The OFFileOwnerAccountID key from the dictionary. | |
unsigned long | fileGroupOwnerAccountID |
The OFFileGroupOwnerAccountID key from the dictionary. | |
OFString * | fileOwnerAccountName |
The OFFileOwnerAccountName key from the dictionary. | |
OFString * | fileGroupOwnerAccountName |
The OFFileGroupOwnerAccountName key from the dictionary. | |
OFDate * | fileLastAccessDate |
The OFFileLastAccessDate key from the dictionary. | |
OFDate * | fileModificationDate |
The OFFileModificationDate key from the dictionary. | |
OFDate * | fileStatusChangeDate |
The OFFileStatusChangeDate key from the dictionary. | |
OFDate * | fileCreationDate |
The OFFileCreationDate key from the dictionary. | |
OFString * | fileSymbolicLinkDestination |
The OFFileSymbolicLinkDestination key from the dictionary. | |
OFArray * | fileExtendedAttributesNames |
The OFFileExtendedAttributesNames key from the dictionary. | |
Properties inherited from OFObject | |
OFString * | className |
The name of the object's class. | |
OFString * | description |
A description for the object. | |
Properties inherited from <OFCollection> | |
size_t | count |
The number of objects in the collection. | |
Properties inherited from <OFJSONRepresentation> | |
OFString * | JSONRepresentation |
The JSON representation of the object as a string. | |
Properties inherited from <OFMessagePackRepresentation> | |
OFData * | messagePackRepresentation |
The MessagePack representation of the object as OFData. | |
An abstract class for storing and changing objects in a dictionary.
- (void) addEntriesFromDictionary: | (OFDictionary *) | dictionary |
Adds the entries from the specified dictionary.
dictionary | The dictionary whose entries should be added |
+ (instancetype) dictionaryWithCapacity: | (size_t) | capacity |
Creates a new OFMutableDictionary with enough memory to hold the specified number of objects.
capacity | The initial capacity for the OFMutableDictionary |
- (instancetype) init |
Initializes an already allocated OFMutableDictionary to be empty.
Reimplemented from OFDictionary.
- (instancetype) initWithCapacity: | (size_t) | capacity |
Initializes an already allocated OFMutableDictionary with enough memory to hold the specified number of objects.
capacity | The initial capacity for the OFMutableDictionary |
- (void) removeObjectForKey: | (KeyType) | key |
Removes the object for the specified key from the dictionary.
key | The key whose object should be removed |
- (void) replaceObjectsUsingBlock: | (OFDictionaryReplaceBlock) | block |
Replaces each object with the object returned by the block.
block | The block which returns a new object for each object |
- (void) setObject: | (ObjectType) | object | |
forKey: | (KeyType) | key |
Sets an object for a key.
A key can be any object that conforms to the OFCopying protocol.
key | The key to set |
object | The object to set the key to |
- (void) setObject: | (nullable ObjectType) | object | |
forKeyedSubscript: | (KeyType) | key |
Sets an object for a key.
A key can be any object that conforms to the OFCopying protocol.
This method is also used by the subscripting syntax.
key | The key to set |
object | The object to set the key to. If it is nil, this is equal to calling removeObjectForKey:. |