|
ObjFW
|
An abstract class for storing objects in a dictionary. More...
#import <ObjFW/OFDictionary.h>
Instance Methods | |
| (instancetype) | - init |
| Initializes an already allocated OFDictionary to be empty. | |
| (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. | |
| fileSize | |
| The OFFileSize key from the dictionary. | |
| fileType | |
| The OFFileType key from the dictionary. | |
| filePOSIXPermissions | |
| The OFFilePOSIXPermissions key from the dictionary. | |
| fileOwnerAccountID | |
| The OFFileOwnerAccountID key from the dictionary. | |
| fileGroupOwnerAccountID | |
| The OFFileGroupOwnerAccountID key from the dictionary. | |
| fileOwnerAccountName | |
| The OFFileOwnerAccountName key from the dictionary. | |
| fileGroupOwnerAccountName | |
| The OFFileGroupOwnerAccountName key from the dictionary. | |
| fileLastAccessDate | |
| The OFFileLastAccessDate key from the dictionary. | |
| fileModificationDate | |
| The OFFileModificationDate key from the dictionary. | |
| fileStatusChangeDate | |
| The OFFileStatusChangeDate key from the dictionary. | |
| fileCreationDate | |
| The OFFileCreationDate key from the dictionary. | |
| fileSymbolicLinkDestination | |
| The OFFileSymbolicLinkDestination key from the dictionary. | |
| fileExtendedAttributesNames | |
| The OFFileExtendedAttributesNames key from the dictionary. | |
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> | |
| (Class) | - class |
| Returns the class of the object. | |
| (nullable Class) | - superclass |
| Returns the superclass of the object. | |
| (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. | |
| (bool) | - conformsToProtocol: |
| Checks whether the object conforms to the specified protocol. | |
| (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. | |
| (OFEnumerator *) | - objectEnumerator |
| Returns an OFEnumerator to enumerate through all objects of the collection. | |
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) | + 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. | |
Properties | |
| OFArray * | allKeys |
| An array of all keys. | |
| OFArray * | allObjects |
| An array of all objects. | |
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 objects in a dictionary.
Keys are copied and thus must conform to the OFCopying protocol.
| - (bool) containsObject: | (ObjectType) | object |
Checks whether the dictionary contains an object equal to the specified object.
| object | The object which is checked for being in the dictionary |
| - (bool) containsObjectIdenticalTo: | (ObjectType) | object |
Checks whether the dictionary contains an object with the specified address.
| object | The object which is checked for being in the dictionary |
| + (instancetype) dictionary |
Creates a new OFDictionary.
| + (instancetype) dictionaryWithDictionary: | (OFDictionary *) | dictionary |
Creates a new OFDictionary with the specified dictionary.
| dictionary | An OFDictionary |
| + (instancetype) dictionaryWithKeysAndObjects: | (KeyType) | firstKey | |
| , | ... | ||
Creates a new OFDictionary with the specified keys objects.
| firstKey | The first key |
| + (instancetype) dictionaryWithObject: | (ObjectType) | object | |
| forKey: | (KeyType) | key | |
Creates a new OFDictionary with the specified key and object.
| key | The key |
| object | The object |
Creates a new OFDictionary with the specified keys and objects.
| keys | An array of keys |
| objects | An array of objects |
| + (instancetype) dictionaryWithObjects: | (ObjectType const *) | objects | |
| forKeys: | (KeyType const *) | keys | |
| count: | (size_t) | count | |
Creates a new OFDictionary with the specified keys and objects.
| keys | An array of keys |
| objects | An array of objects |
| count | The number of objects in the arrays |
| - (void) enumerateKeysAndObjectsUsingBlock: | (OFDictionaryEnumerationBlock) | block |
Executes a block for each key / object pair.
| block | The block to execute for each key / object pair. |
| - (OFDictionary *) filteredDictionaryUsingBlock: | (OFDictionaryFilterBlock) | block |
Creates a new dictionary, only containing the objects for which the block returns true.
| block | A block which determines if the object should be in the new dictionary |
| - (instancetype) init |
Initializes an already allocated OFDictionary to be empty.
Reimplemented from OFObject.
Reimplemented in OFMutableDictionary.
| - (instancetype) initWithDictionary: | (OFDictionary *) | dictionary |
Initializes an already allocated OFDictionary with the specified OFDictionary.
| dictionary | An OFDictionary |
| - (instancetype) initWithKey: | (KeyType) | firstKey | |
| arguments: | (va_list) | arguments | |
Initializes an already allocated OFDictionary with the specified key and va_list.
| firstKey | The first key |
| arguments | A va_list of the other arguments |
| - (instancetype) initWithKeysAndObjects: | (KeyType) | firstKey | |
| , | ... | ||
Initializes an already allocated OFDictionary with the specified keys and objects.
| firstKey | The first key |
| - (instancetype) initWithObject: | (ObjectType) | object | |
| forKey: | (KeyType) | key | |
Initializes an already allocated OFDictionary with the specified key and object.
| key | The key |
| object | The object |
Initializes an already allocated OFDictionary with the specified keys and objects.
| keys | An array of keys |
| objects | An array of objects |
| - (instancetype) initWithObjects: | (ObjectType const *) | objects | |
| forKeys: | (KeyType const *) | keys | |
| count: | (size_t) | count | |
Initializes an already allocated OFDictionary with the specified keys and objects.
| keys | An array of keys |
| objects | An array of objects |
| count | The number of objects in the arrays |
| - (OFEnumerator *) keyEnumerator |
Returns an OFEnumerator to enumerate through the dictionary's keys.
| - (OFDictionary *) mappedDictionaryUsingBlock: | (OFDictionaryMapBlock) | block |
Creates a new dictionary, mapping each object using the specified block.
| block | A block which maps an object for each object |
| - (OFEnumerator *) objectEnumerator |
Returns an OFEnumerator to enumerate through the dictionary's objects.
Reimplemented from <OFEnumeration>.
| - (nullable ObjectType) objectForKey: | (KeyType) | key |
Returns the object for the given key or nil if the key was not found.
| key | The key whose object should be returned |
nil if the key was not found | - (void) setValue: | (nullable id) | value | |
| forKey: | (OFString *) | key | |
Sets a value for a key.
This is equivalent to setObject:forKey: (OFMutableDictionary).
| key | The key to set |
| value | The value to set the key to |
| OFUndefinedKeyException | The dictionary is immutable |
| - (id) valueForKey: | (OFString *) | key |
Returns the value for the given key or nil if the key was not found.
This is equivalent to objectForKey:.
The special key @count can be used to retrieve the count as an OFNumber.
| key | The key whose value should be returned |
nil if the key was not found