ObjFW
Instance Methods | Class Methods | Properties | List of all members
OFValue Class Reference

A class for storing arbitrary values in an object. More...

#import <ObjFW/OFValue.h>

Inheritance diagram for OFValue:
Inheritance graph
[legend]
Collaboration diagram for OFValue:
Collaboration graph
[legend]

Instance Methods

(instancetype) - initWithBytes:objCType:
 Initializes an already allocated OFValue with the specified bytes of the specified type. More...
 
(instancetype) - initWithPointer:
 Initializes an already allocated OFValue containing the specified pointer. More...
 
(instancetype) - initWithNonretainedObject:
 Initializes an already allocated OFValue containing the specified non-retained object. More...
 
(instancetype) - initWithRange:
 Initializes an already allocated OFValue containing the specified range. More...
 
(instancetype) - initWithPoint:
 Initializes an already allocated OFValue containing the specified point. More...
 
(instancetype) - initWithDimension:
 Initializes an already allocated OFValue containing the specified dimension. More...
 
(instancetype) - initWithRectangle:
 Initializes an already allocated OFValue containing the specified rectangle. More...
 
(void) - getValue:size:
 Gets the value. More...
 
- Instance Methods inherited from OFObject
(instancetype) - init
 Initializes an already allocated object. More...
 
(nullable OFMethodSignature *) - methodSignatureForSelector:
 Returns the method signature for the specified selector. 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:withObject:withObject:withObject:afterDelay:
 Performs the specified selector with the specified objects after the specified delay. More...
 
(void) - performSelector:withObject:withObject: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) - performSelector:onThread:withObject:withObject:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified objects. More...
 
(void) - performSelector:onThread:withObject:withObject: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) - performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified objects. More...
 
(void) - performSelectorOnMainThread:withObject:withObject: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...
 
(void) - performSelector:onThread:withObject:withObject:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified objects after the specified delay. More...
 
(void) - performSelector:onThread:withObject:withObject: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...
 
- Instance Methods inherited from <OFObject>
(unsigned long) - hash
 Returns a 32 bit hash for the object. More...
 
(unsigned int) - retainCount
 Returns the retain count. More...
 
(bool) - isProxy
 Returns whether the object is a proxy object. More...
 
(bool) - allowsWeakReference
 Returns whether the object allows weak references. More...
 
(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 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...
 
(nullable id- performSelector:withObject:withObject:withObject:
 Performs the specified selector with the specified objects. More...
 
(nullable id- performSelector:withObject:withObject:withObject:withObject:
 Performs the specified selector with the specified objects. More...
 
(bool) - isEqual:
 Checks two objects for equality. More...
 
(instancetype) - retain
 Increases the retain count. More...
 
(void) - release
 Decreases the retain count. More...
 
(instancetype) - autorelease
 Adds the object to the topmost autorelease pool of the thread's autorelease pool stack. More...
 
(instancetype) - self
 Returns the receiver. More...
 
(bool) - retainWeakReference
 Retain a weak reference to this object. More...
 
- Instance Methods inherited from <OFCopying>
(id- copy
 Copies the object. More...
 

Class Methods

(instancetype) + valueWithBytes:objCType:
 Creates a new, autorelease OFValue with the specified bytes of the specified type. More...
 
(instancetype) + valueWithPointer:
 Creates a new, autoreleased OFValue containing the specified pointer. More...
 
(instancetype) + valueWithNonretainedObject:
 Creates a new, autoreleased OFValue containing the specified non-retained object. More...
 
(instancetype) + valueWithRange:
 Creates a new, autoreleased OFValue containing the specified range. More...
 
(instancetype) + valueWithPoint:
 Creates a new, autoreleased OFValue containing the specified point. More...
 
(instancetype) + valueWithDimension:
 Creates a new, autoreleased OFValue containing the specified dimension. More...
 
(instancetype) + valueWithRectangle:
 Creates a new, autoreleased OFValue containing the specified rectangle. 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...
 
(instancetype) + alloc
 Allocates memory for an instance of the class and sets up the memory pool for the object. More...
 
(instancetype) + new
 Calls alloc on self and then init on the returned object. 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...
 
(nullable 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 OFMethodSignature *) + instanceMethodSignatureForSelector:
 Returns the method signature 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...
 
(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...
 

Properties

const char * objCType
 The ObjC type encoding of the value.
 
void * pointerValue
 The value as a pointer to void. More...
 
id nonretainedObjectValue
 The value as a non-retained object. More...
 
of_range_t rangeValue
 The value as a range. More...
 
of_point_t pointValue
 The value as a point. More...
 
of_dimension_t dimensionValue
 The value as a dimension. More...
 
of_rectangle_t rectangleValue
 The value as a rectangle. More...
 
- Properties inherited from OFObject
OFStringclassName
 The name of the object's class.
 
OFStringdescription
 A description for the object. More...
 
OFStringstringBySerializing
 The object serialized as a string.
 

Detailed Description

A class for storing arbitrary values in an object.

Method Documentation

◆ getValue:size:

- (void) getValue: (void *)  value
size: (size_t)  size 

Gets the value.

If the specified size does not match, this raises an OFOutOfRangeException.

Parameters
valueThe buffer to copy the value into
sizeThe size of the value

◆ initWithBytes:objCType:

- (instancetype) initWithBytes: (const void *)  bytes
objCType: (const char *)  objCType 

Initializes an already allocated OFValue with the specified bytes of the specified type.

Parameters
bytesThe bytes containing the value
objCTypeThe ObjC type encoding for the value
Returns
An initialized OFValue

◆ initWithDimension:

- (instancetype) initWithDimension: (of_dimension_t dimension

Initializes an already allocated OFValue containing the specified dimension.

Parameters
dimensionThe dimension the OFValue should contain
Returns
An initialized OFValue

◆ initWithNonretainedObject:

- (instancetype) initWithNonretainedObject: (id object

Initializes an already allocated OFValue containing the specified non-retained object.

The object is not retained, which makes this useful for storing objects in collections without retaining them.

Parameters
objectThe object the OFValue should contain without retaining it
Returns
An initialized OFValue

◆ initWithPoint:

- (instancetype) initWithPoint: (of_point_t point

Initializes an already allocated OFValue containing the specified point.

Parameters
pointThe point the OFValue should contain
Returns
An initialized OFValue

◆ initWithPointer:

- (instancetype) initWithPointer: (const void *)  pointer

Initializes an already allocated OFValue containing the specified pointer.

Only the raw value of the pointer is stored and no data will be copied.

Parameters
pointerThe pointer the OFValue should contain
Returns
An initialized OFValue

◆ initWithRange:

- (instancetype) initWithRange: (of_range_t range

Initializes an already allocated OFValue containing the specified range.

Parameters
rangeThe range the OFValue should contain
Returns
An initialized OFValue

◆ initWithRectangle:

- (instancetype) initWithRectangle: (of_rectangle_t rectangle

Initializes an already allocated OFValue containing the specified rectangle.

Parameters
rectangleThe rectangle the OFValue should contain
Returns
An initialized OFValue

◆ valueWithBytes:objCType:

+ (instancetype) valueWithBytes: (const void *)  bytes
objCType: (const char *)  objCType 

Creates a new, autorelease OFValue with the specified bytes of the specified type.

Parameters
bytesThe bytes containing the value
objCTypeThe ObjC type encoding for the value
Returns
A new, autoreleased OFValue

◆ valueWithDimension:

+ (instancetype) valueWithDimension: (of_dimension_t dimension

Creates a new, autoreleased OFValue containing the specified dimension.

Parameters
dimensionThe dimension the OFValue should contain
Returns
A new, autoreleased OFValue

◆ valueWithNonretainedObject:

+ (instancetype) valueWithNonretainedObject: (id object

Creates a new, autoreleased OFValue containing the specified non-retained object.

The object is not retained, which makes this useful for storing objects in collections without retaining them.

Parameters
objectThe object the OFValue should contain without retaining it
Returns
A new, autoreleased OFValue

◆ valueWithPoint:

+ (instancetype) valueWithPoint: (of_point_t point

Creates a new, autoreleased OFValue containing the specified point.

Parameters
pointThe point the OFValue should contain
Returns
A new, autoreleased OFValue

◆ valueWithPointer:

+ (instancetype) valueWithPointer: (const void *)  pointer

Creates a new, autoreleased OFValue containing the specified pointer.

Only the raw value of the pointer is stored and no data will be copied.

Parameters
pointerThe pointer the OFValue should contain
Returns
A new, autoreleased OFValue

◆ valueWithRange:

+ (instancetype) valueWithRange: (of_range_t range

Creates a new, autoreleased OFValue containing the specified range.

Parameters
rangeThe range the OFValue should contain
Returns
A new, autoreleased OFValue

◆ valueWithRectangle:

+ (instancetype) valueWithRectangle: (of_rectangle_t rectangle

Creates a new, autoreleased OFValue containing the specified rectangle.

Parameters
rectangleThe rectangle the OFValue should contain
Returns
A new, autoreleased OFValue

Property Documentation

◆ dimensionValue

- (of_dimension_t) dimensionValue
readnonatomicassign

The value as a dimension.

If the value is not dimension-sized, OFOutOfRangeException is thrown.

◆ nonretainedObjectValue

- (id) nonretainedObjectValue
readnonatomicassign

The value as a non-retained object.

If the value is not pointer-sized, OFOutOfRangeException is thrown.

◆ pointerValue

- (void *) pointerValue
readnonatomicassign

The value as a pointer to void.

If the value is not pointer-sized, OFOutOfRangeException is thrown.

◆ pointValue

- (of_point_t) pointValue
readnonatomicassign

The value as a point.

If the value is not point-sized, OFOutOfRangeException is thrown.

◆ rangeValue

- (of_range_t) rangeValue
readnonatomicassign

The value as a range.

If the value is not range-sized, OFOutOfRangeException is thrown.

◆ rectangleValue

- (of_rectangle_t) rectangleValue
readnonatomicassign

The value as a rectangle.

If the value is not rectangle-sized, OFOutOfRangeException is thrown.


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