ObjFW
Loading...
Searching...
No Matches
Instance Methods | Properties | List of all members
OFINICategory Class Reference

A class for representing a category of an INI file. More...

#include <ObjFW/OFINICategory.h>

Inheritance diagram for OFINICategory:
OFObject <OFObject>

Instance Methods

(nullable OFString *) - stringValueForKey:
 Returns the string for the specified key, or nil if it does not exist.
 
(nullable OFString *) - stringValueForKey:defaultValue:
 Returns the string for the specified key or the specified default value if it does not exist.
 
(long long) - longLongValueForKey:defaultValue:
 Returns the long long value for the specified key or the specified default value if it does not exist.
 
(bool) - boolValueForKey:defaultValue:
 Returns the bool value for the specified key or the specified default value if it does not exist.
 
(float) - floatValueForKey:defaultValue:
 Returns the float value for the specified key or the specified default value if it does not exist.
 
(double) - doubleValueForKey:defaultValue:
 Returns the double value for the specified key or the specified default value if it does not exist.
 
(OFArray *) - arrayValueForKey:
 Returns an array of strings for the specified multi-key, or an empty array if the key does not exist.
 
(void) - setStringValue:forKey:
 Sets the value of the specified key to the specified string.
 
(void) - setLongLongValue:forKey:
 Sets the value of the specified key to the specified long long.
 
(void) - setBoolValue:forKey:
 Sets the value of the specified key to the specified bool.
 
(void) - setFloatValue:forKey:
 Sets the value of the specified key to the specified float.
 
(void) - setDoubleValue:forKey:
 Sets the value of the specified key to the specified double.
 
(void) - setArrayValue:forKey:
 Sets the specified multi-key to the specified array of strings.
 
(void) - removeValueForKey:
 Removes the value for the specified key.
 
- 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.
 

Properties

OFStringname
 The name of the INI category.
 
- Properties inherited from OFObject
OFStringclassName
 The name of the object's class.
 
OFStringdescription
 A description for the object.
 

Additional Inherited Members

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

Detailed Description

A class for representing a category of an INI file.

Method Documentation

◆ arrayValueForKey:

- (OFArray *) arrayValueForKey: (OFString *) key

Returns an array of strings for the specified multi-key, or an empty array if the key does not exist.

A multi-key is a key which exists several times in the same category. Each occurrence of the key/value pair adds the respective value to the array.

Parameters
keyThe multi-key for which the array should be returned
Returns
The array for the specified key, or an empty array if it does not exist

◆ boolValueForKey:defaultValue:

- (bool) boolValueForKey: (OFString *) key
defaultValue: (bool) defaultValue 

Returns the bool value for the specified key or the specified default value if it does not exist.

If the specified key is a multi-key (see arrayValueForKey:), the value of the first key/value pair found is returned.

Parameters
keyThe key for which the bool should be returned
defaultValueThe value to return if the key does not exist
Returns
The bool for the specified key or the specified default value if it does not exist
Exceptions
OFInvalidFormatExceptionThe specified key is not in the correct format for a bool

◆ doubleValueForKey:defaultValue:

- (double) doubleValueForKey: (OFString *) key
defaultValue: (double) defaultValue 

Returns the double value for the specified key or the specified default value if it does not exist.

If the specified key is a multi-key (see arrayValueForKey:), the value of the first key/value pair found is returned.

Parameters
keyThe key for which the double should be returned
defaultValueThe value to return if the key does not exist
Returns
The double for the specified key or the specified default value if it does not exist
Exceptions
OFInvalidFormatExceptionThe specified key is not in the correct format for a double

◆ floatValueForKey:defaultValue:

- (float) floatValueForKey: (OFString *) key
defaultValue: (float) defaultValue 

Returns the float value for the specified key or the specified default value if it does not exist.

If the specified key is a multi-key (see arrayValueForKey:), the value of the first key/value pair found is returned.

Parameters
keyThe key for which the float should be returned
defaultValueThe value to return if the key does not exist
Returns
The float for the specified key or the specified default value if it does not exist
Exceptions
OFInvalidFormatExceptionThe specified key is not in the correct format for a float

◆ longLongValueForKey:defaultValue:

- (long long) longLongValueForKey: (OFString *) key
defaultValue: (long long) defaultValue 

Returns the long long value for the specified key or the specified default value if it does not exist.

If the specified key is a multi-key (see arrayValueForKey:), the value of the first key/value pair found is returned.

Parameters
keyThe key for which the long long should be returned
defaultValueThe value to return if the key does not exist
Returns
The long long for the specified key or the specified default value if it does not exist
Exceptions
OFInvalidFormatExceptionThe specified key is not in the correct format for a long long

◆ removeValueForKey:

- (void) removeValueForKey: (OFString *) key

Removes the value for the specified key.

If the specified key is a multi-key (see arrayValueForKey:), all key/value pairs matching the specified key are removed.

Parameters
keyThe key of the value to remove

◆ setArrayValue:forKey:

- (void) setArrayValue: (OFArray *) arrayValue
forKey: (OFString *) key 

Sets the specified multi-key to the specified array of strings.

It replaces the first occurrence of the multi-key with several key/value pairs and removes all following occurrences. If the multi-key does not exist yet, it is appended to the section.

See also arrayValueForKey: for more information about multi-keys.

Parameters
arrayValueThe array of strings to which the multi-key should be set
keyThe multi-key for which the new values should be set

◆ setBoolValue:forKey:

- (void) setBoolValue: (bool) boolValue
forKey: (OFString *) key 

Sets the value of the specified key to the specified bool.

If the specified key is a multi-key (see arrayValueForKey:), the value of the first key/value pair found is changed.

Parameters
boolValueThe bool to which the key should be set
keyThe key for which the new value should be set

◆ setDoubleValue:forKey:

- (void) setDoubleValue: (double) doubleValue
forKey: (OFString *) key 

Sets the value of the specified key to the specified double.

If the specified key is a multi-key (see arrayValueForKey:), the value of the first key/value pair found is changed.

Parameters
doubleValueThe double to which the key should be set
keyThe key for which the new value should be set

◆ setFloatValue:forKey:

- (void) setFloatValue: (float) floatValue
forKey: (OFString *) key 

Sets the value of the specified key to the specified float.

If the specified key is a multi-key (see arrayValueForKey:), the value of the first key/value pair found is changed.

Parameters
floatValueThe float to which the key should be set
keyThe key for which the new value should be set

◆ setLongLongValue:forKey:

- (void) setLongLongValue: (long long) longLongValue
forKey: (OFString *) key 

Sets the value of the specified key to the specified long long.

If the specified key is a multi-key (see arrayValueForKey:), the value of the first key/value pair found is changed.

Parameters
longLongValueThe long long to which the key should be set
keyThe key for which the new value should be set

◆ setStringValue:forKey:

- (void) setStringValue: (OFString *) stringValue
forKey: (OFString *) key 

Sets the value of the specified key to the specified string.

If the specified key is a multi-key (see arrayValueForKey:), the value of the first key/value pair found is changed.

Parameters
stringValueThe string to which the key should be set
keyThe key for which the new value should be set

◆ stringValueForKey:

- (OFString *) stringValueForKey: (OFString *) key

Returns the string for the specified key, or nil if it does not exist.

If the specified key is a multi-key (see arrayValueForKey:), the value of the first key/value pair found is returned.

Parameters
keyThe key for which the string should be returned
Returns
The string for the specified key, or nil if it does not exist

◆ stringValueForKey:defaultValue:

- (nullable OFString *) stringValueForKey: (OFString *) key
defaultValue: (nullable OFString *) defaultValue 

Returns the string for the specified key or the specified default value if it does not exist.

If the specified key is a multi-key (see arrayValueForKey:), the value of the first key/value pair found is returned.

Parameters
keyThe key for which the string should be returned
defaultValueThe value to return if the key does not exist
Returns
The string for the specified key or the specified default value if it does not exist

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