ObjFW
Instance Methods | Class Methods | List of all members
OFMutableArray Class Reference

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

#import <ObjFW/OFArray.h>

Inheritance diagram for OFMutableArray:
OFArray OFObject <OFCopying> <OFMutableCopying> <OFCollection> <OFSerialization> <OFJSONRepresentation> <OFMessagePackRepresentation> <OFObject> <OFEnumerating> <OFFastEnumeration>

Instance Methods

(id) - initWithCapacity:
 Initializes an already allocated OFMutableArray with enough memory to hold the specified number of objects. More...
 
(void) - addObject:
 Adds an object to the end of the array. More...
 
(void) - addObjectsFromArray:
 Adds the objects from the specified OFArray to the end of the array. More...
 
(void) - insertObject:atIndex:
 Inserts an object to the OFArray at the specified index. More...
 
(void) - insertObjectsFromArray:atIndex:
 Inserts the objects from the specified OFArray at the specified index. More...
 
(void) - replaceObject:withObject:
 Replaces the first object equivalent to the specified object with the other specified object. More...
 
(void) - replaceObjectAtIndex:withObject:
 Replaces the object at the specified index with the specified object. More...
 
(void) - replaceObjectIdenticalTo:withObject:
 Replaces the first object that has the same address as the specified object with the other specified object. More...
 
(void) - removeObject:
 Removes the first object equivalent to the specified object. More...
 
(void) - removeObjectIdenticalTo:
 Removes the first object that has the same address as the specified object. More...
 
(void) - removeObjectAtIndex:
 Removes the object at the specified index. More...
 
(void) - removeObjectsInRange:
 Removes the object in the specified range. More...
 
(void) - removeLastObject
 Removes the last object.
 
(void) - removeAllObjects
 Removes all objects.
 
(void) - replaceObjectsUsingBlock:
 Replaces each object with the object returned by the block. More...
 
(void) - exchangeObjectAtIndex:withObjectAtIndex:
 Exchange the objects at the specified indices. More...
 
(void) - sort
 Sorts the array.
 
(void) - sortWithOptions:
 Sorts the array. More...
 
(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
(id) - initWithObject:
 Initializes an OFArray with the specified object. More...
 
(id) - initWithObjects:
 Initializes an OFArray with the specified objects. More...
 
(id) - initWithObject:arguments:
 Initializes an OFArray with the specified object and a va_list. More...
 
(id) - initWithArray:
 Initializes an OFArray with the objects from the specified array. More...
 
(id) - initWithObjects:count:
 Initializes an OFArray with the objects from the specified C array of the specified length. More...
 
(ObjectType) - objectAtIndex:
 Returns the object at the specified index in the array. More...
 
(void) - getObjects:inRange:
 Copies the objects at the specified range to the specified buffer. More...
 
(ObjectType const __unsafe_unretained OF_NONNULL *OF_NONNULL) - objects
 Returns the objects of the array as a C array. More...
 
(size_t) - indexOfObject:
 Returns the index of the first object that is equivalent to the specified object or OF_NOT_FOUND if it was not found. More...
 
(size_t) - indexOfObjectIdenticalTo:
 Returns the index of the first object that has the same address as the specified object or OF_NOT_FOUND if it was not found. More...
 
(bool) - containsObject:
 Checks whether the array contains an object equal to the specified object. More...
 
(bool) - containsObjectIdenticalTo:
 Checks whether the array contains an object with the specified address. More...
 
(nullable ObjectType) - firstObject
 Returns the first object of the array or nil. More...
 
(nullable ObjectType) - lastObject
 Returns the last object of the array or nil. More...
 
(OFArray OF_GENERIC(ObjectType) - objectsInRange:
 Returns the objects in the specified range as a new OFArray. More...
 
(OFString *) - componentsJoinedByString:
 Creates a string by joining all objects of the array. More...
 
(OFString *) - componentsJoinedByString:options:
 Creates a string by joining all objects of the array. More...
 
(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. More...
 
(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. More...
 
(void) - makeObjectsPerformSelector:
 Performs the specified selector on all objects in the array. More...
 
(void) - makeObjectsPerformSelector:withObject:
 Performs the specified selector on all objects in the array with the specified object. More...
 
(OFArray OF_GENERIC(ObjectType) - sortedArray
 Returns a sorted copy of the array. More...
 
(OFArray OF_GENERIC(ObjectType) - sortedArrayWithOptions:
 Returns a sorted copy of the array. More...
 
(OFArray OF_GENERIC(ObjectType) - reversedArray
 Returns a copy of the array with the order reversed. More...
 
(OFArray OF_GENERIC(ObjectType) - arrayByAddingObject:
 Creates a new array with the specified object added. More...
 
(OFArray OF_GENERIC(ObjectType) - arrayByAddingObjectsFromArray:
 Creates a new array with the objects from the specified array added. More...
 
(OFArray OF_GENERIC(ObjectType) - arrayByRemovingObject:
 Creates a new array with the specified object removed. More...
 
(OFEnumerator OF_GENERIC(ObjectType) - objectEnumerator
 Returns an OFEnumerator to enumerate through all objects of the array. More...
 
(void) - enumerateObjectsUsingBlock:
 Executes a block for each object. More...
 
(OFArray *) - mappedArrayUsingBlock:
 Creates a new array, mapping each object using the specified block. More...
 
(OFArray OF_GENERIC(ObjectType) - filteredArrayUsingBlock:
 Creates a new array, only containing the objects for which the block returns true. More...
 
(nullable id) - foldUsingBlock:
 Folds the array to a single object using the specified block. 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...
 
(void *) - allocMemoryWithSize:
 Allocates memory and stores it in the object's memory pool. More...
 
(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...
 
- Instance Methods inherited from <OFCopying>
(id) - copy
 Copies the object. More...
 
- Instance Methods inherited from <OFMutableCopying>
(id) - mutableCopy
 Creates a mutable copy of the object. More...
 
- Instance Methods inherited from <OFCollection>
(size_t) - count
 Returns the number of objects in the collection. More...
 
(bool) - containsObject:
 Checks whether the collection contains an object equal to the specified object. More...
 
- 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. More...
 
- Instance Methods inherited from <OFSerialization>
(id) - initWithSerialization:
 Initializes the object with the specified XML element serialization. More...
 
(OFXMLElement *) - XMLElementBySerializing
 Serializes the object into an XML element. More...
 
- Instance Methods inherited from <OFJSONRepresentation>
(OFString *) - JSONRepresentation
 Returns the JSON representation of the object as a string. More...
 
(OFString *) - JSONRepresentationWithOptions:
 Returns the JSON representation of the object as a string. More...
 
- Instance Methods inherited from <OFMessagePackRepresentation>
(OFDataArray *) - messagePackRepresentation
 Returns the MessagePack representation of the object as an OFDataArray. More...
 

Class Methods

(instancetype) + arrayWithCapacity:
 Creates a new OFMutableArray with enough memory to hold the specified number of objects. More...
 
- Class Methods inherited from OFArray
(instancetype) + array
 Creates a new OFArray. More...
 
(instancetype) + arrayWithObject:
 Creates a new OFArray with the specified object. More...
 
(instancetype) + arrayWithObjects:
 Creates a new OFArray with the specified objects, terminated by nil. More...
 
(instancetype) + arrayWithArray:
 Creates a new OFArray with the objects from the specified array. More...
 
(instancetype) + arrayWithObjects:count:
 Creates a new OFArray with the objects from the specified C array of the specified length. More...
 
- 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...
 
(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

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

Method Documentation

- (void) addObject: (ObjectType)  object

Adds an object to the end of the array.

Parameters
objectAn object to add
- (void) addObjectsFromArray: (OFArray OF_GENERIC(ObjectType)*)  array

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

Parameters
arrayAn array of objects to add
+ (instancetype) arrayWithCapacity: (size_t)  capacity

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

Parameters
capacityThe initial capacity for the OFMutableArray
Returns
A new autoreleased OFMutableArray
- (void) exchangeObjectAtIndex: (size_t)  index1
withObjectAtIndex: (size_t)  index2 

Exchange the objects at the specified indices.

Parameters
index1The index of the first object to exchange
index2The index of the second object to exchange
- (id) initWithCapacity: (size_t)  capacity

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

Parameters
capacityThe initial capacity for the OFMutableArray
Returns
An initialized OFMutableArray
- (void) insertObject: (ObjectType)  object
atIndex: (size_t)  index 

Inserts an object to the OFArray at the specified index.

Parameters
objectAn object to add
indexThe index where the object should be inserted
- (void) insertObjectsFromArray: (OFArray OF_GENERIC(ObjectType)*)  array
atIndex: (size_t)  index 

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

Parameters
arrayAn array of objects
indexThe index where the objects should be inserted
- (void) removeObject: (ObjectType)  object

Removes the first object equivalent to the specified object.

Parameters
objectThe object to remove
- (void) removeObjectAtIndex: (size_t)  index

Removes the object at the specified index.

Parameters
indexThe index of the object to remove
- (void) removeObjectIdenticalTo: (ObjectType)  object

Removes the first object that has the same address as the specified object.

Parameters
objectThe object to remove
- (void) removeObjectsInRange: (of_range_t range

Removes the object in the specified range.

Parameters
rangeThe range of the objects to remove
- (void) replaceObject: (ObjectType)  oldObject
withObject: (ObjectType)  newObject 

Replaces the first object equivalent to the specified object with the other specified object.

Parameters
oldObjectThe object to replace
newObjectThe replacement object
- (void) replaceObjectAtIndex: (size_t)  index
withObject: (ObjectType)  object 

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

Parameters
indexThe index of the object to replace
objectThe replacement object
- (void) replaceObjectIdenticalTo: (ObjectType)  oldObject
withObject: (ObjectType)  newObject 

Replaces the first object that has the same address as the specified object with the other specified object.

Parameters
oldObjectThe object to replace
newObjectThe replacement object
- (void) replaceObjectsUsingBlock: (of_array_replace_block_t block

Replaces each object with the object returned by the block.

Parameters
blockThe block which returns a new object for each object
- (void) sortWithOptions: (int)  options

Sorts the array.

Parameters
optionsThe options to use when sorting the array.
Possible values are:
Value Description
OF_ARRAY_SORT_DESCENDING Sort in descending order

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