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

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

#include <ObjFW/OFList.h>

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

Instance Methods

(OFListItem- appendObject:
 Appends an object to the list.
 
(OFListItem- prependObject:
 Prepends an object to the list.
 
(OFListItem- insertObject:beforeListItem:
 Inserts an object before another list object.
 
(OFListItem- insertObject:afterListItem:
 Inserts an object after another list object.
 
(void) - removeListItem:
 Removes the object with the specified list object from the list.
 
(bool) - containsObject:
 Checks whether the list contains an object equal to the specified object.
 
(bool) - containsObjectIdenticalTo:
 Checks whether the list contains an object with the specified address.
 
(void) - removeAllObjects
 Removes all objects from the list.
 
- Instance Methods inherited from OFObject
(instancetype) - init
 Initializes an already allocated object.
 
(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 <OFCollection>
(bool) - containsObject:
 Checks whether the collection contains an object equal to the specified object.
 
- Instance Methods inherited from <OFEnumeration>
(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.
 

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) + 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

OFListItem firstListItem
 The first list object of the list.
 
ObjectType firstObject
 The first object of the list or nil.
 
OFListItem lastListItem
 The last list object of the list.
 
ObjectType lastObject
 The last object of the list or nil.
 
- 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.
 

Detailed Description

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

Method Documentation

◆ appendObject:

- (OFListItem) appendObject: (ObjectType) object

Appends an object to the list.

Parameters
objectThe object to append
Returns
An OFListItem, needed to identify the object inside the list. For example, if you want to remove an object from the list, you need its OFListItem.

Reimplemented in OFSortedList.

◆ containsObject:

- (bool) containsObject: (ObjectType) object

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

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

◆ containsObjectIdenticalTo:

- (bool) containsObjectIdenticalTo: (ObjectType) 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

◆ insertObject:afterListItem:

- (OFListItem) insertObject: (ObjectType) object
afterListItem: (OFListItem) listItem 

Inserts an object after another list object.

Parameters
objectThe object to insert
listItemThe OFListItem of the object after which it should be inserted
Returns
An OFListItem, needed to identify the object inside the list. For example, if you want to remove an object from the list, you need its OFListItem.

Reimplemented in OFSortedList.

◆ insertObject:beforeListItem:

- (OFListItem) insertObject: (ObjectType) object
beforeListItem: (OFListItem) listItem 

Inserts an object before another list object.

Parameters
objectThe object to insert
listItemThe OFListItem of the object before which it should be inserted
Returns
An OFListItem, needed to identify the object inside the list. For example, if you want to remove an object from the list, you need its OFListItem.

Reimplemented in OFSortedList.

◆ list

+ (instancetype) list

Creates a new OFList.

Returns
A new autoreleased OFList

◆ prependObject:

- (OFListItem) prependObject: (ObjectType) object

Prepends an object to the list.

Parameters
objectThe object to prepend
Returns
An OFListItem, needed to identify the object inside the list. For example, if you want to remove an object from the list, you need its OFListItem.

Reimplemented in OFSortedList.

◆ removeListItem:

- (void) removeListItem: (OFListItem) listItem

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

Parameters
listItemThe list object returned by append / prepend

Property Documentation

◆ firstObject

- (id) firstObject
readwriteatomic

The first object of the list or nil.

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

◆ lastObject

- (id) lastObject
readwriteatomic

The last object of the list or nil.

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

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