An abstract class for storing objects in an array. More...

#import <ObjFW/OFArray.h>

Inheritance diagram for OFArray:

Instance Methods
(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)	+ 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 objects in an array.

Method Documentation

+ (instancetype) array

Creates a new OFArray.

Returns: A new autoreleased OFArray

- (OFArray OF_GENERIC(ObjectType) arrayByAddingObject: (ObjectType) object

Creates a new array with the specified object added.

Parameters

object The object to add

Returns: A new array with the specified object added

- (OFArray OF_GENERIC(ObjectType) arrayByAddingObjectsFromArray: (OFArray OF_GENERIC(ObjectType)*) array

Creates a new array with the objects from the specified array added.

Parameters

array The array with objects to add

Returns: A new array with the objects from the specified array added

- (OFArray OF_GENERIC(ObjectType) arrayByRemovingObject: (ObjectType) object

Creates a new array with the specified object removed.

Parameters

object The object to remove

Returns: A new array with the specified object removed

+ (instancetype) arrayWithArray: (OFArray OF_GENERIC(ObjectType)*) array

Creates a new OFArray with the objects from the specified array.

Parameters

array An array

Returns: A new autoreleased OFArray

+ (instancetype) arrayWithObject: (ObjectType) object

Creates a new OFArray with the specified object.

Parameters

object An object

Returns: A new autoreleased OFArray

+ (instancetype) arrayWithObjects:	(ObjectType)	firstObject
,		...

Creates a new OFArray with the specified objects, terminated by nil.

Parameters

firstObject The first object in the array

Returns: A new autoreleased OFArray

+ (instancetype) arrayWithObjects:	(ObjectType const OF_NONNULL *OF_NONNULL)	objects
count:	(size_t)	count

Creates a new OFArray with the objects from the specified C array of the specified length.

Parameters

objects	A C array of objects
count	The length of the C array

Returns: A new autoreleased OFArray

- (OFString *) componentsJoinedByString: (OFString*) separator

Creates a string by joining all objects of the array.

Parameters

separator The string with which the objects should be joined

Returns: A string containing all objects joined by the separator

- (OFString *) componentsJoinedByString:	(OFString*)	separator
options:	(int)	options

Creates a string by joining all objects of the array.

Parameters

separator The string with which the objects should be joined

options

Options according to which the objects should be joined.
Possible values are:

Value	Description
`OF_ARRAY_SKIP_EMPTY`	Skip empty components

Returns: A string containing all objects joined by the separator

- (OFString *) componentsJoinedByString:	(OFString*)	separator
usingSelector:	(SEL)	selector

Creates a string by calling the selector on all objects of the array and joining the strings returned by calling the selector.

Parameters

separator	The string with which the objects should be joined
selector	The selector to perform on the objects

Returns: A string containing all objects joined by the separator

- (OFString *) componentsJoinedByString:	(OFString*)	separator
usingSelector:	(SEL)	selector
options:	(int)	options

Creates a string by calling the selector on all objects of the array and joining the strings returned by calling the selector.

Parameters

separator The string with which the objects should be joined

selector The selector to perform on the objects

options

Options according to which the objects should be joined.
Possible values are:

Value	Description
`OF_ARRAY_SKIP_EMPTY`	Skip empty components

Returns: A string containing all objects joined by the separator

- (bool) containsObject: (nullable ObjectType) object

Checks whether the array contains an object equal to the specified object.

Parameters

object The object which is checked for being in the array

Returns: A boolean whether the array contains the specified object

- (bool) containsObjectIdenticalTo: (nullable ObjectType) object

Checks whether the array contains an object with the specified address.

Parameters

object The object which is checked for being in the array

Returns: A boolean whether the array contains an object with the specified address

- (void) enumerateObjectsUsingBlock: (of_array_enumeration_block_t) block

Executes a block for each object.

Parameters

block The block to execute for each object

- (OFArray *) filteredArrayUsingBlock: (of_array_filter_block_t) block

Creates a new array, only containing the objects for which the block returns true.

Parameters

block A block which determines if the object should be in the new array

Returns: A new, autoreleased OFArray

- (id) firstObject

Returns the first object of the array or nil.

Warning: The returned object is not retained and autoreleased for performance reasons!

Returns: The first object of the array or nil

- (id) foldUsingBlock: (of_array_fold_block_t) block

Folds the array to a single object using the specified block.

If the array is empty, it will return nil.

If there is only one object in the array, that object will be returned and the block will not be invoked.

If there are at least two objects, the block is invoked for each object except the first, where left is always to what the array has already been folded and right what should be added to left.

Parameters

block A block which folds two objects into one, which is called for all objects except the first

Returns: The array folded to a single object

- (void) getObjects:	(ObjectType __unsafe_unretained OF_NONNULL *OF_NONNULL)	buffer
inRange:	(of_range_t)	range

Copies the objects at the specified range to the specified buffer.

Parameters

buffer	The buffer to copy the objects to
range	The range to copy

- (size_t) indexOfObject: (ObjectType) object

Returns the index of the first object that is equivalent to the specified object or OF_NOT_FOUND if it was not found.

Parameters

object The object whose index is returned

Returns: The index of the first object equivalent to the specified object or OF_NOT_FOUND if it was not found

- (size_t) indexOfObjectIdenticalTo: (ObjectType) object

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.

Parameters

object The object whose index is returned

Returns: The index of the first object that has the same aaddress as the specified object or OF_NOT_FOUND if it was not found

- (id) initWithArray: (OFArray OF_GENERIC(ObjectType)*) array

Initializes an OFArray with the objects from the specified array.

Parameters

array An array

Returns: An initialized OFArray

- (id) initWithObject: (ObjectType) object

Initializes an OFArray with the specified object.

Parameters

object An object

Returns: An initialized OFArray

- (id) initWithObject:	(ObjectType)	firstObject
arguments:	(va_list)	arguments

Initializes an OFArray with the specified object and a va_list.

Parameters

firstObject	The first object
arguments	A va_list

Returns: An initialized OFArray

- (id) initWithObjects:	(ObjectType)	firstObject
,		...

Initializes an OFArray with the specified objects.

Parameters

firstObject The first object

Returns: An initialized OFArray

- (id) initWithObjects:	(ObjectType const OF_NONNULL *OF_NONNULL)	objects
count:	(size_t)	count

Initializes an OFArray with the objects from the specified C array of the specified length.

Parameters

objects	A C array of objects
count	The length of the C array

Returns: An initialized OFArray

- (id) lastObject

Returns the last object of the array or nil.

Warning: The returned object is not retained and autoreleased for performance reasons!

Returns: The last object of the array or nil

- (void) makeObjectsPerformSelector: (SEL) selector

Performs the specified selector on all objects in the array.

Parameters

selector The selector to perform on all objects in the array

- (void) makeObjectsPerformSelector:	(SEL)	selector
withObject:	(nullable id)	object

Performs the specified selector on all objects in the array with the specified object.

Parameters

selector	The selector to perform on all objects in the array
object	The object to perform the selector with on all objects in the array

- (OFArray *) mappedArrayUsingBlock: (of_array_map_block_t) block

Creates a new array, mapping each object using the specified block.

Parameters

block A block which maps an object for each object

Returns: A new, autoreleased OFArray

- (id) objectAtIndex: (size_t) index

Returns the object at the specified index in the array.

Warning: The returned object is not retained and autoreleased for performance reasons!

Parameters

index The index of the object to return

Returns: The object at the specified index in the array

- (OFEnumerator *) objectEnumerator

Returns an OFEnumerator to enumerate through all objects of the array.

Returns: An OFEnumerator to enumerate through all objects of the array

Reimplemented from <OFEnumerating>.

- (id const *) objects

Returns the objects of the array as a C array.

Returns: The objects of the array as a C array

- (OFArray *) objectsInRange: (of_range_t) range

Returns the objects in the specified range as a new OFArray.

Parameters

range The range for the subarray

Returns: The subarray as a new autoreleased OFArray

- (OFArray *) reversedArray

Returns a copy of the array with the order reversed.

Returns: A copy of the array with the order reversed

- (OFArray *) sortedArray

Returns a sorted copy of the array.

Returns: A sorted copy of the array

- (OFArray *) sortedArrayWithOptions: (int) options

Returns a sorted copy of the array.

Parameters

options

The options to use when sorting the array.
Possible values are:

Value	Description
`OF_ARRAY_SORT_DESCENDING`	Sort in descending order

Returns: A sorted copy of the array

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

src/OFArray.h
src/OFArray.m

Instance Methods

Class Methods

Detailed Description

Method Documentation