An abstract class for storing, adding and removing objects in an array. More...

#include <ObjFW/OFArray.h>

Inheritance diagram for OFMutableArray:

Instance Methods
(instancetype)	- init
	Initializes an OFMutableArray with no objects.

(instancetype)	- initWithCapacity:
	Initializes an already allocated OFMutableArray with enough memory to hold the specified number of objects.

(void)	- addObject:
	Adds an object to the end of the array.

(void)	- addObjectsFromArray:
	Adds the objects from the specified OFArray to the end of the array.

(void)	- insertObject:atIndex:
	Inserts an object to the OFArray at the specified index.

(void)	- insertObjectsFromArray:atIndex:
	Inserts the objects from the specified OFArray at the specified index.

(void)	- replaceObject:withObject:
	Replaces all objects equivalent to the specified object with the other specified object.

(void)	- replaceObjectAtIndex:withObject:
	Replaces the object at the specified index with the specified object.

(void)	- setObject:atIndexedSubscript:
	Replaces the object at the specified index with the specified object.

(void)	- replaceObjectIdenticalTo:withObject:
	Replaces all objects that have the same address as the specified object with the other specified object.

(void)	- removeObject:
	Removes all objects equivalent to the specified object.

(void)	- removeObjectIdenticalTo:
	Removes all objects that have the same address as the specified object.

(void)	- removeObjectAtIndex:
	Removes the object at the specified index.

(void)	- removeObjectsInRange:
	Removes the objects in the specified range.

(void)	- removeLastObject
	Removes the last object.

(void)	- removeAllObjects
	Removes all objects.

(void)	- replaceObjectsUsingBlock:
	Replaces each object with the object returned by the block.

(void)	- exchangeObjectAtIndex:withObjectAtIndex:
	Exchange the objects at the specified indices.

(void)	- sort
	Sorts the array in ascending order.

(void)	- sortUsingSelector:options:
	Sorts the array using the specified selector and options.

(void)	- sortUsingFunction:context:options:
	Sorts the array using the specified function and options.

(void)	- sortUsingComparator:options:
	Sorts the array using the specified comparator and options.

(void)	- reverse
	Reverts the order of the objects in the array.

(void)	- makeImmutable
	Converts the mutable array to an immutable array.

Instance Methods inherited from OFArray
(instancetype)	- initWithObject:
	Initializes an OFArray with the specified object.

(instancetype)	- initWithObjects:
	Initializes an OFArray with the specified objects.

(instancetype)	- initWithObject:arguments:
	Initializes an OFArray with the specified object and a va_list.

(instancetype)	- initWithArray:
	Initializes an OFArray with the objects from the specified array.

(instancetype)	- initWithObjects:count:
	Initializes an OFArray with the objects from the specified C array of the specified length.

(OFEnumerator *)	- objectEnumerator
	Returns an OFEnumerator to enumerate through all objects of the array.

(ObjectType)	- objectAtIndex:
	Returns the object at the specified index in the array.

(nullable id)	- valueForKey:
	Returns the value for the specified key.

(void)	- setValue:forKey:
	Set the value for the specified key.

(void)	- getObjects:inRange:
	Copies the objects at the specified range to the specified buffer.

(size_t)	- indexOfObject:
	Returns the index of the first object that is equivalent to the specified object or `OFNotFound` if it was not found.

(size_t)	- indexOfObjectIdenticalTo:
	Returns the index of the first object that has the same address as the specified object or `OFNotFound` if it was not found.

(bool)	- containsObject:
	Checks whether the array contains an object equal to the specified object.

(bool)	- containsObjectIdenticalTo:
	Checks whether the array contains an object with the specified address.

(OFArray *)	- objectsInRange:
	Returns the objects in the specified range as a new OFArray.

(OFString *)	- componentsJoinedByString:
	Creates a string by joining all objects of the array.

(OFString *)	- componentsJoinedByString:options:
	Creates a string by joining all objects of the array.

(OFString *)	- componentsJoinedByString:usingSelector:
	Creates a string by calling the selector on all objects of the array and joining the strings returned by calling the selector.

(OFString *)	- componentsJoinedByString:usingSelector:options:
	Creates a string by calling the selector on all objects of the array and joining the strings returned by calling the selector.

(void)	- makeObjectsPerformSelector:
	Performs the specified selector on all objects in the array.

(void)	- makeObjectsPerformSelector:withObject:
	Performs the specified selector on all objects in the array with the specified object.

(OFArray *)	- sortedArrayUsingSelector:options:
	Returns a copy of the array sorted using the specified selector and options.

(OFArray *)	- sortedArrayUsingFunction:context:options:
	Returns a copy of the array sorted using the specified function and options.

(OFArray *)	- sortedArrayUsingComparator:options:
	Returns a copy of the array sorted using the specified selector and options.

(OFArray *)	- arrayByAddingObject:
	Creates a new array with the specified object added.

(OFArray *)	- arrayByAddingObjectsFromArray:
	Creates a new array with the objects from the specified array added.

(void)	- enumerateObjectsUsingBlock:
	Executes a block for each object.

(OFArray *)	- mappedArrayUsingBlock:
	Creates a new array, mapping each object using the specified block.

(OFArray *)	- filteredArrayUsingBlock:
	Creates a new array, only containing the objects for which the block returns true.

(nullable id)	- foldUsingBlock:
	Folds the array to a single object using the specified block.

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 <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)	+ arrayWithCapacity:
	Creates a new OFMutableArray with enough memory to hold the specified number of objects.

Class Methods inherited from OFArray
(instancetype)	+ array
	Creates a new OFArray.

(instancetype)	+ arrayWithObject:
	Creates a new OFArray with the specified object.

(instancetype)	+ arrayWithObjects:
	Creates a new OFArray with the specified objects, terminated by `nil`.

(instancetype)	+ arrayWithArray:
	Creates a new OFArray with the objects from the specified array.

(instancetype)	+ arrayWithObjects:count:
	Creates a new OFArray with the objects from the specified C array of the specified length.

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 OFArray
ObjectType const __unsafe_unretained *	objects
	The objects of the array as a C array.

ObjectType	firstObject
	The first object of the array or `nil`.

ObjectType	lastObject
	The last object of the array or `nil`.

OFArray *	sortedArray
	The array sorted in ascending order.

OFArray *	reversedArray
	The array with the order reversed.

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.

Detailed Description

An abstract class for storing, adding and removing objects in an array.

Note: Subclasses must implement insertObject:atIndex: (OFMutableArray), replaceObjectAtIndex:withObject: (OFMutableArray), removeObjectAtIndex: (OFMutableArray) as well as all methods of OFArray that need to be implemented.

Method Documentation

◆ addObject:

- (void) addObject: (ObjectType) object

Adds an object to the end of the array.

Parameters

object An object to add

◆ addObjectsFromArray:

- (void) addObjectsFromArray: (OFArray *) array

Adds the objects from the specified OFArray to the end of the array.

Parameters

array An array of objects to add

◆ arrayWithCapacity:

+ (instancetype) arrayWithCapacity: (size_t) capacity

Creates a new OFMutableArray with enough memory to hold the specified number of objects.

Parameters

capacity The initial capacity for the OFMutableArray

Returns: A new autoreleased OFMutableArray

◆ exchangeObjectAtIndex:withObjectAtIndex:

- (void) exchangeObjectAtIndex:		(size_t)	index1
withObjectAtIndex:		(size_t)	index2

Exchange the objects at the specified indices.

Parameters

index1	The index of the first object to exchange
index2	The index of the second object to exchange

◆ init

- (instancetype) init

Initializes an OFMutableArray with no objects.

Returns: An initialized OFMutableArray

Reimplemented from OFArray.

◆ initWithCapacity:

- (instancetype) initWithCapacity: (size_t) capacity

Initializes an already allocated OFMutableArray with enough memory to hold the specified number of objects.

Parameters

capacity The initial capacity for the OFMutableArray

Returns: An initialized OFMutableArray

◆ insertObject:atIndex:

- (void) insertObject:		(ObjectType)	object
atIndex:		(size_t)	index

Inserts an object to the OFArray at the specified index.

Parameters

object	An object to add
index	The index where the object should be inserted

◆ insertObjectsFromArray:atIndex:

- (void) insertObjectsFromArray:		(OFArray *)	array
atIndex:		(size_t)	index

Inserts the objects from the specified OFArray at the specified index.

Parameters

array	An array of objects
index	The index where the objects should be inserted

◆ removeObject:

- (void) removeObject: (ObjectType) object

Removes all objects equivalent to the specified object.

Parameters

object The object to remove

◆ removeObjectAtIndex:

- (void) removeObjectAtIndex: (size_t) index

Removes the object at the specified index.

Parameters

index The index of the object to remove

◆ removeObjectIdenticalTo:

- (void) removeObjectIdenticalTo: (ObjectType) object

Removes all objects that have the same address as the specified object.

Parameters

object The object to remove

◆ removeObjectsInRange:

- (void) removeObjectsInRange: (OFRange) range

Removes the objects in the specified range.

Parameters

range The range of the objects to remove

◆ replaceObject:withObject:

- (void) replaceObject:		(ObjectType)	oldObject
withObject:		(ObjectType)	newObject

Replaces all objects equivalent to the specified object with the other specified object.

Parameters

oldObject	The object to replace
newObject	The replacement object

◆ replaceObjectAtIndex:withObject:

- (void) replaceObjectAtIndex:		(size_t)	index
withObject:		(ObjectType)	object

Replaces the object at the specified index with the specified object.

Parameters

index	The index of the object to replace
object	The replacement object

◆ replaceObjectIdenticalTo:withObject:

- (void) replaceObjectIdenticalTo:		(ObjectType)	oldObject
withObject:		(ObjectType)	newObject

Replaces all objects that have the same address as the specified object with the other specified object.

Parameters

oldObject	The object to replace
newObject	The replacement object

◆ replaceObjectsUsingBlock:

- (void) replaceObjectsUsingBlock: (OFArrayReplaceBlock) block

Replaces each object with the object returned by the block.

Parameters

block The block which returns a new object for each object

◆ setObject:atIndexedSubscript:

- (void) setObject:		(ObjectType)	object
atIndexedSubscript:		(size_t)	index

Replaces the object at the specified index with the specified object.

This method is the same as replaceObjectAtIndex:withObject:.

This method is also used by the subscripting syntax.

Parameters

index	The index of the object to replace
object	The replacement object

◆ sortUsingComparator:options:

- (void) sortUsingComparator:		(OFComparator)	comparator
options:		(OFArraySortOptions)	options

Sorts the array using the specified comparator and options.

Parameters

comparator	The comparator to use to sort the array
options	The options to use when sorting the array

◆ sortUsingFunction:context:options:

- (void) sortUsingFunction:	(OFCompareFunction)	compare
context:	(nullable void *)	context
options:	(OFArraySortOptions)	options

Sorts the array using the specified function and options.

Parameters

compare	The function to use to sort the array
context	Context passed to the function to compare
options	The options to use when sorting the array

◆ sortUsingSelector:options:

- (void) sortUsingSelector:		(SEL)	selector
options:		(OFArraySortOptions)	options

Sorts the array using the specified selector and options.

Parameters

selector	The selector to use to sort the array. It's signature should be the same as that of -[compare:].
options	The options to use when sorting the array

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

src/OFMutableArray.h
src/OFMutableArray.m

Instance Methods

Class Methods

Additional Inherited Members

Detailed Description

Method Documentation

◆ addObject:

◆ addObjectsFromArray:

◆ arrayWithCapacity:

◆ exchangeObjectAtIndex:withObjectAtIndex:

◆ init

◆ initWithCapacity:

◆ insertObject:atIndex:

◆ insertObjectsFromArray:atIndex:

◆ removeObject:

◆ removeObjectAtIndex:

◆ removeObjectIdenticalTo:

◆ removeObjectsInRange:

◆ replaceObject:withObject:

◆ replaceObjectAtIndex:withObject:

◆ replaceObjectIdenticalTo:withObject:

◆ replaceObjectsUsingBlock:

◆ setObject:atIndexedSubscript:

◆ sortUsingComparator:options:

◆ sortUsingFunction:context:options:

◆ sortUsingSelector:options: