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

#import <ObjFW/OFINICategory.h>

Inheritance diagram for OFINICategory:

Instance Methods
(nullable OFString *)	- stringForKey:
	Returns the string value for the specified key, or `nil` if it does not exist. More...

(nullable OFString *)	- stringForKey:defaultValue:
	Returns the string value for the specified key or the specified default value if it does not exist. More...

(intmax_t)	- integerForKey:defaultValue:
	Returns the integer value for the specified key or the specified default value if it does not exist. More...

(bool)	- boolForKey:defaultValue:
	Returns the bool value for the specified key or the specified default value if it does not exist. More...

(float)	- floatForKey:defaultValue:
	Returns the float value for the specified key or the specified default value if it does not exist. More...

(double)	- doubleForKey:defaultValue:
	Returns the double value for the specified key or the specified default value if it does not exist. More...

(OFArray *)	- arrayForKey:
	Returns an array of string values for the specified multi-key, or an empty array if the key does not exist. More...

(void)	- setString:forKey:
	Sets the value of the specified key to the specified string. More...

(void)	- setInteger:forKey:
	Sets the value of the specified key to the specified integer. More...

(void)	- setBool:forKey:
	Sets the value of the specified key to the specified bool. More...

(void)	- setFloat:forKey:
	Sets the value of the specified key to the specified float. More...

(void)	- setDouble:forKey:
	Sets the value of the specified key to the specified double. More...

(void)	- setArray:forKey:
	Sets the specified multi-key to the specified array of strings. More...

(void)	- removeValueForKey:
	Removes the value for the specified key. 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...

(nullable void *)	- allocMemoryWithSize:
	Allocates memory and stores it in the object's memory pool. More...

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

(bool)	- allowsWeakReference
	Returns whether the class allows weak references. More...

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

Properties
OFString *	name

Additional Inherited Members
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...

(nullable 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 for representing a category of an INI file.

Method Documentation

◆ arrayForKey:()

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

Returns an array of string values 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

key	The 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

◆ boolForKey:defaultValue:()

- (bool) boolForKey:	(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 arrayForKey:), the value of the first key/value pair found is returned.

Parameters

key	The key for which the bool value should be returned
defaultValue	The value to return if the key does not exist

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

◆ doubleForKey:defaultValue:()

- (double) doubleForKey:	(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 arrayForKey:), the value of the first key/value pair found is returned.

Parameters

key	The key for which the double value should be returned
defaultValue	The value to return if the key does not exist

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

◆ floatForKey:defaultValue:()

- (float) floatForKey:	(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 arrayForKey:), the value of the first key/value pair found is returned.

Parameters

key	The key for which the float value should be returned
defaultValue	The value to return if the key does not exist

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

◆ integerForKey:defaultValue:()

- (intmax_t) integerForKey:	(OFString *)	key
defaultValue:	(intmax_t)	defaultValue

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

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

Parameters

key	The key for which the integer value should be returned
defaultValue	The value to return if the key does not exist

Returns: The integer value for the specified key or the specified default value if it does not exist

◆ removeValueForKey:()

- (void) removeValueForKey: (OFString *) key

Removes the value for the specified key.

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

Parameters

key	The key of the value to remove

◆ setArray:forKey:()

- (void) setArray:	(OFArray *)	array
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 arrayForKey: for more information about multi-keys.

Parameters

array	The array of strings to which the multi-key should be set
key	The multi-key for which the new values should be set

◆ setBool:forKey:()

- (void) setBool:	(bool)	bool_
forKey:	(OFString *)	key

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

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

Parameters

bool_	The bool to which the value of the key should be set
key	The key for which the new value should be set

◆ setDouble:forKey:()

- (void) setDouble:	(double)	double_
forKey:	(OFString *)	key

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

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

Parameters

double_	The double to which the value of the key should be set
key	The key for which the new value should be set

◆ setFloat:forKey:()

- (void) setFloat:	(float)	float_
forKey:	(OFString *)	key

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

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

Parameters

float_	The float to which the value of the key should be set
key	The key for which the new value should be set

◆ setInteger:forKey:()

- (void) setInteger:	(intmax_t)	integer
forKey:	(OFString *)	key

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

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

Parameters

integer	The integer to which the value of the key should be set
key	The key for which the new value should be set

◆ setString:forKey:()

- (void) setString:	(OFString *)	string
forKey:	(OFString *)	key

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

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

Parameters

string	The string to which the value of the key should be set
key	The key for which the new value should be set

◆ stringForKey:()

- (OFString *) stringForKey: (OFString *) key

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

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

Parameters

key	The key for which the string value should be returned

Returns: The string value for the specified key, or nil if it does not exist

◆ stringForKey:defaultValue:()

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

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

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

Parameters

key	The key for which the string value should be returned
defaultValue	The value to return if the key does not exist

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

Property Documentation

◆ name

- (OFString*) name

readwritenonatomiccopy

The name of the INI category

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

src/OFINICategory.h
src/OFINICategory.m

Instance Methods

Properties

Additional Inherited Members

Detailed Description

Method Documentation

◆ arrayForKey:()

◆ boolForKey:defaultValue:()

◆ doubleForKey:defaultValue:()

◆ floatForKey:defaultValue:()

◆ integerForKey:defaultValue:()

◆ removeValueForKey:()

◆ setArray:forKey:()

◆ setBool:forKey:()

◆ setDouble:forKey:()

◆ setFloat:forKey:()

◆ setInteger:forKey:()

◆ setString:forKey:()

◆ stringForKey:()

◆ stringForKey:defaultValue:()

Property Documentation

◆ name