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

#import <OFArray.h>

Inheritance diagram for OFArray:

Instance Methods
(id)	- initWithObject:
	Initializes an OFArray with the specified object.

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

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

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

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

(id)	- objectAtIndex:
	Returns a specified object of the array.

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

(id *)	- objects
	Returns the objects of the array as a C array.

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

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

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

(id)	- firstObject
	Returns the first object of the array or nil.

(id)	- lastObject
	Returns the last object of the array or nil.

(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:usingSelector:
	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 *)	- sortedArray
	Returns a sorted copy of the array.

(OFArray *)	- reversedArray
	Returns a copy of the array with the order reversed.

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

(OFArray *)	- arrayByRemovingObject:
	Creates a new array with the specified object removed.

Instance Methods inherited from OFObject
(id)	- init
	Initializes an already allocated object.

(OFString *)	- className
	Returns the name of the object's class.

(OFString *)	- description
	Returns a description for the object.

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

(void *)	- allocMemoryWithSize:count:
	Allocates memory for the specified number of items and stores it in the object's memory pool.

(void *)	- resizeMemory:size:
	Resizes memory in the object's memory pool to the specified size.

(void *)	- resizeMemory:size:count:
	Resizes memory in the object's memory pool to the specific number of items of the specified size.

(void)	- freeMemory:
	Frees allocated memory and removes it from the object's memory pool.

(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: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)	- 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)	- 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.

(OFString *)	- stringBySerializing
	Creates a string by serializing the receiver.

Instance Methods inherited from <OFObject>
(BOOL)	- isKindOfClass:
	Returns a boolean whether the object 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.

(IMP)	- methodForSelector:
	Returns the implementation for the specified selector.

(const char *)	- typeEncodingForSelector:
	Returns the type encoding for the specified selector.

(id)	- performSelector:
	Performs the specified selector.

(id)	- performSelector:withObject:
	Performs the specified selector with the specified object.

(id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects.

(BOOL)	- isEqual:
	Checks two objects for equality.

(uint32_t)	- hash
	Calculates a hash for the object.

(id)	- retain
	Increases the retain count.

(unsigned int)	- retainCount
	Returns the retain count.

(void)	- release
	Decreases the retain count.

(id)	- autorelease
	Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack.

(id)	- self
	Returns the receiver.

(BOOL)	- isProxy
	Returns whether the object is a proxy 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>
(size_t)	- count
	Returns the number of objects in the collection.

(BOOL)	- containsObject:
	Checks whether the collection contains an object equal to the specified object.

Instance Methods inherited from <OFEnumerating>
(OFEnumerator *)	- objectEnumerator
	Returns an OFEnumerator to enumerate through all objects of the collection.

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 <OFSerialization>
(id)	- initWithSerialization:
	Initializes the object with the specified XML element serialization.

(OFXMLElement *)	- XMLElementBySerializing
	Serializes the object into an XML element.

Instance Methods inherited from <OFJSONRepresentation>
(OFString *)	- JSONRepresentation
	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)	+ initialize
	A method which is called the moment before the first call to the class is being made.

(id)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object.

(id)	+ new
	Allocates memory for a new instance and calls -[init] on it.

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

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

(IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector.

(const char *)	+ typeEncodingForInstanceSelector:
	Returns the type encoding of the instance method for the specified selector.

(OFString *)	+ description
	Returns a description for the class, which is usually the class name.

(IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class.

(IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class.

(IMP)	+ replaceClassMethod:withImplementation:typeEncoding:
	Replaces or adds a class method.

(IMP)	+ replaceInstanceMethod:withImplementation:typeEncoding:
	Replaces or adds an instance method.

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

Additional Inherited Members
Public Attributes inherited from OFObject
Class	isa
	The class of the object.

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 *) arrayByAddingObject: (id) 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 *) arrayByAddingObjectsFromArray: (OFArray*) 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 *) arrayByRemovingObject: (id) 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*) array

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

Parameters

array An array

Returns: A new autoreleased OFArray

+ (instancetype) arrayWithObject: (id) object

Creates a new OFArray with the specified object.

Parameters

object An object

Returns: A new autoreleased OFArray

+ (instancetype) arrayWithObjects:	(id)	firstObject
,		OF_SENTINEL

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:	(id const*)	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
length	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
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

- (BOOL) containsObjectIdenticalTo: (id) 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.

- (id) firstObject

Returns the first object of the array or nil.

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

Returns: The first object of the array or nil

- (void) getObjects:	(__unsafe_unretained id *)	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: (id) 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: (id) 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*) array

Initializes an OFArray with the objects from the specified array.

Parameters

array An array

Returns: An initialized OFArray

- (id) initWithObject: (id) object

Initializes an OFArray with the specified object.

Parameters

object An object

Returns: An initialized OFArray

- (id) initWithObject:	(id)	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:	(id)	firstObject
,		OF_SENTINEL

Initializes an OFArray with the specified objects.

Parameters

firstObject The first object

Returns: An initialized OFArray

- (id) initWithObjects:	(id const*)	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
length	The length of the C array

Returns: An initialized OFArray

- (id) lastObject

Returns the last object of the array or nil.

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:	(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

- (id) objectAtIndex: (size_t) index

Returns a specified object of the array.

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

Parameters

index The number of the object to return

Returns: The specified object of the OFArray

- (id *) 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

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

src/OFArray.h
src/OFArray.m

Instance Methods

Class Methods

Additional Inherited Members

Detailed Description

Method Documentation