ObjFW
 All Classes Functions Variables
Instance Methods | Class Methods | List of all members
OFList Class Reference

A class which provides easy to use double-linked lists. More...

#import <OFList.h>

Inheritance diagram for OFList:
OFObject <OFCopying> <OFCollection> <OFSerialization> <OFObject> <OFEnumerating> <OFFastEnumeration> OFSortedList

Instance Methods

(of_list_object_t *) - firstListObject
 Returns the first list object of the list.
 
(of_list_object_t *) - lastListObject
 Retrusn the last list object of the list.
 
(of_list_object_t *) - appendObject:
 Appends an object to the list.
 
(of_list_object_t *) - prependObject:
 Prepends an object to the list.
 
(of_list_object_t *) - insertObject:beforeListObject:
 Inserts an object before another list object.
 
(of_list_object_t *) - insertObject:afterListObject:
 Inserts an object after another list object.
 
(void) - removeListObject:
 Removes the object with the specified list object from the list.
 
(BOOL) - containsObjectIdenticalTo:
 Checks whether the list contains an object with the specified address.
 
(id) - firstObject
 Returns the first object of the list or nil.
 
(id) - lastObject
 Returns the last object of the list or nil.
 
(void) - removeAllObjects
 Removes all objects from the list.
 
- 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 <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.
 

Class Methods

(instancetype) + list
 Creates a new OFList.
 
- 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.
 

Detailed Description

A class which provides easy to use double-linked lists.

Method Documentation

- (of_list_object_t *) appendObject: (id)  object

Appends an object to the list.

Parameters
objectThe object to append
Returns
An of_list_object_t, needed to identify the object inside the list. For example, if you want to remove an object from the list, you need its of_list_object_t.
- (BOOL) containsObjectIdenticalTo: (id)  object

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

Parameters
objectThe object which is checked for being in the list
Returns
A boolean whether the list contains an object with the specified address.
- (of_list_object_t*) firstListObject

Returns the first list object of the list.

Returns
The first list object of the list
- (id) firstObject

Returns the first object of the list or nil.

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

Returns
The first object of the list or nil
- (of_list_object_t *) insertObject: (id)  object
afterListObject: (of_list_object_t*)  listObject 

Inserts an object after another list object.

Parameters
objectThe object to insert
listObjectThe of_list_object_t of the object after which it should be inserted
Returns
An of_list_object_t, needed to identify the object inside the list. For example, if you want to remove an object from the list, you need its of_list_object_t.
- (of_list_object_t *) insertObject: (id)  object
beforeListObject: (of_list_object_t*)  listObject 

Inserts an object before another list object.

Parameters
objectThe object to insert
listObjectThe of_list_object_t of the object before which it should be inserted
Returns
An of_list_object_t, needed to identify the object inside the list. For example, if you want to remove an object from the list, you need its of_list_object_t.
- (of_list_object_t*) lastListObject

Retrusn the last list object of the list.

Returns
The last list object of the list
- (id) lastObject

Returns the last object of the list or nil.

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

Returns
The last object of the list or nil
+ (instancetype) list

Creates a new OFList.

Returns
A new autoreleased OFList
- (of_list_object_t *) prependObject: (id)  object

Prepends an object to the list.

Parameters
objectThe object to prepend
Returns
An of_list_object_t, needed to identify the object inside the list. For example, if you want to remove an object from the list, you need its of_list_object_t.
- (void) removeListObject: (of_list_object_t*)  listObject

Removes the object with the specified list object from the list.

Parameters
listObjectThe list object returned by append / prepend

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