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

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

#include <ObjFW/OFArray.h>

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

Instance Methods

(instancetype) - init
 Initializes an OFArray with no objects.
 
(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) + 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.
 

Properties

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.
 
OFArraysortedArray
 The array sorted in ascending order.
 
OFArrayreversedArray
 The array with the order reversed.
 
- Properties inherited from OFObject
OFStringclassName
 The name of the object's class.
 
OFStringdescription
 A description for the object.
 
- Properties inherited from <OFCollection>
size_t count
 The number of objects in the collection.
 
- Properties inherited from <OFJSONRepresentation>
OFStringJSONRepresentation
 The JSON representation of the object as a string.
 
- Properties inherited from <OFMessagePackRepresentation>
OFDatamessagePackRepresentation
 The MessagePack representation of the object as OFData.
 

Detailed Description

An abstract class for storing objects in an array.

Note
Subclasses must implement count and objectAtIndex: (OFArray).

Method Documentation

◆ array

+ (instancetype) array

Creates a new OFArray.

Returns
A new autoreleased OFArray

◆ arrayByAddingObject:

- (OFArray *) arrayByAddingObject: (ObjectType) object

Creates a new array with the specified object added.

Parameters
objectThe object to add
Returns
A new array with the specified object added

◆ arrayByAddingObjectsFromArray:

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

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

Parameters
arrayThe array with objects to add
Returns
A new array with the objects from the specified array added

◆ arrayWithArray:

+ (instancetype) arrayWithArray: (OFArray *) array

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

Parameters
arrayAn array
Returns
A new autoreleased OFArray

◆ arrayWithObject:

+ (instancetype) arrayWithObject: (ObjectType) object

Creates a new OFArray with the specified object.

Parameters
objectAn object
Returns
A new autoreleased OFArray

◆ arrayWithObjects:

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

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

Parameters
firstObjectThe first object in the array
Returns
A new autoreleased OFArray

◆ arrayWithObjects:count:

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

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

Parameters
objectsA C array of objects
countThe length of the C array
Returns
A new autoreleased OFArray

◆ componentsJoinedByString:

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

Creates a string by joining all objects of the array.

Parameters
separatorThe string with which the objects should be joined
Returns
A string containing all objects joined by the separator

◆ componentsJoinedByString:options:

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

Creates a string by joining all objects of the array.

Parameters
separatorThe string with which the objects should be joined
optionsOptions according to which the objects should be joined
Returns
A string containing all objects joined by the separator

◆ componentsJoinedByString:usingSelector:

- (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
separatorThe string with which the objects should be joined
selectorThe selector to perform on the objects
Returns
A string containing all objects joined by the separator

◆ componentsJoinedByString:usingSelector:options:

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

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

Parameters
separatorThe string with which the objects should be joined
selectorThe selector to perform on the objects
optionsOptions according to which the objects should be joined
Returns
A string containing all objects joined by the separator

◆ containsObject:

- (bool) containsObject: (ObjectType) object

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

Parameters
objectThe object which is checked for being in the array
Returns
A boolean whether the array contains the specified object

◆ containsObjectIdenticalTo:

- (bool) containsObjectIdenticalTo: (ObjectType) object

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

Parameters
objectThe object which is checked for being in the array
Returns
A boolean whether the array contains an object with the specified address

◆ enumerateObjectsUsingBlock:

- (void) enumerateObjectsUsingBlock: (OFArrayEnumerationBlock) block

Executes a block for each object.

Parameters
blockThe block to execute for each object

◆ filteredArrayUsingBlock:

- (OFArray *) filteredArrayUsingBlock: (OFArrayFilterBlock) block

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

Parameters
blockA block which determines if the object should be in the new array
Returns
A new, autoreleased OFArray

◆ foldUsingBlock:

- (id) foldUsingBlock: (OFArrayFoldBlock) 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
blockA block which folds two objects into one, which is called for all objects except the first
Returns
The array folded to a single object

◆ getObjects:inRange:

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

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

Parameters
bufferThe buffer to copy the objects to
rangeThe range to copy

◆ indexOfObject:

- (size_t) indexOfObject: (ObjectType) object

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

Parameters
objectThe object whose index is returned
Returns
The index of the first object equivalent to the specified object or OFNotFound if it was not found

◆ indexOfObjectIdenticalTo:

- (size_t) indexOfObjectIdenticalTo: (ObjectType) object

Returns the index of the first object that has the same address as the specified object or OFNotFound if it was not found.

Parameters
objectThe object whose index is returned
Returns
The index of the first object that has the same address as the specified object or OFNotFound if it was not found

◆ init

- (instancetype) init

Initializes an OFArray with no objects.

Returns
An initialized OFArray

Reimplemented from OFObject.

Reimplemented in OFMutableArray.

◆ initWithArray:

- (instancetype) initWithArray: (OFArray *) array

Initializes an OFArray with the objects from the specified array.

Parameters
arrayAn array
Returns
An initialized OFArray

◆ initWithObject:

- (instancetype) initWithObject: (ObjectType) object

Initializes an OFArray with the specified object.

Parameters
objectAn object
Returns
An initialized OFArray

◆ initWithObject:arguments:

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

Initializes an OFArray with the specified object and a va_list.

Parameters
firstObjectThe first object
argumentsA va_list
Returns
An initialized OFArray

◆ initWithObjects:

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

Initializes an OFArray with the specified objects.

Parameters
firstObjectThe first object
Returns
An initialized OFArray

◆ initWithObjects:count:

- (instancetype) initWithObjects: (ObjectType const *) objects
count: (size_t) count 

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

Parameters
objectsA C array of objects
countThe length of the C array
Returns
An initialized OFArray

◆ makeObjectsPerformSelector:

- (void) makeObjectsPerformSelector: (SEL) selector

Performs the specified selector on all objects in the array.

Parameters
selectorThe selector to perform on all objects in the array

◆ makeObjectsPerformSelector:withObject:

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

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

Parameters
selectorThe selector to perform on all objects in the array
objectThe object to perform the selector with on all objects in the array

◆ mappedArrayUsingBlock:

- (OFArray *) mappedArrayUsingBlock: (OFArrayMapBlock) block

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

Parameters
blockA block which maps an object for each object
Returns
A new, autoreleased OFArray

◆ objectAtIndex:

- (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
indexThe index of the object to return
Returns
The object at the specified index in the array

◆ objectEnumerator

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

◆ objectsInRange:

- (OFArray *) objectsInRange: (OFRange) range

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

Parameters
rangeThe range for the subarray
Returns
The subarray as a new autoreleased OFArray

◆ setValue:forKey:

- (void) setValue: (nullable id) value
forKey: (OFString *) key 

Set the value for the specified key.

setValue:forKey: is called for each object in the array.

Note
A OFNull value is translated to nil!
Parameters
valueThe value for the specified key
keyThe key of the value to set

◆ sortedArrayUsingComparator:options:

- (OFArray *) sortedArrayUsingComparator: (OFComparator) comparator
options: (OFArraySortOptions) options 

Returns a copy of the array sorted using the specified selector and options.

Parameters
comparatorThe comparator to use to sort the array
optionsThe options to use when sorting the array
Returns
A sorted copy of the array

◆ sortedArrayUsingFunction:context:options:

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

Returns a copy of the array sorted using the specified function and options.

Parameters
compareThe function to use to sort the array
contextContext passed to the function to compare
optionsThe options to use when sorting the array
Returns
A sorted copy of the array

◆ sortedArrayUsingSelector:options:

- (OFArray *) sortedArrayUsingSelector: (SEL) selector
options: (OFArraySortOptions) options 

Returns a copy of the array sorted using the specified selector and options.

Parameters
selectorThe selector to use to sort the array. It's signature should be the same as that of -[compare:].
optionsThe options to use when sorting the array
Returns
A sorted copy of the array

◆ valueForKey:

- (id) valueForKey: (OFString *) key

Returns the value for the specified key.

A new array with the value for the specified key for each object is returned.

The special key @count can be used to retrieve the count as an OFNumber.

Note
Any nil values are replaced with OFNull!
Parameters
keyThe key of the value to return
Returns
The value for the specified key

Property Documentation

◆ firstObject

- (id) firstObject
readwriteatomic

The first object of the array or nil.

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

◆ lastObject

- (id) lastObject
readwriteatomic

The last object of the array or nil.

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

◆ objects

- (id const *) objects
readnonatomicassign

The objects of the array as a C array.

The result is valid until the autorelease pool is released. If you want to use the result outside the scope of the current autorelease pool, you have to copy it.


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