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

Provides a way to store a number in an object. More...

#include <ObjFW/OFNumber.h>

Inheritance diagram for OFNumber:
OFValue <OFComparing> <OFJSONRepresentation> <OFMessagePackRepresentation> OFObject <OFCopying> <OFObject>

Instance Methods

(instancetype) - initWithBool:
 Initializes an already allocated OFNumber with the specified bool.
 
(instancetype) - initWithChar:
 Initializes an already allocated OFNumber with the specified signed char.
 
(instancetype) - initWithShort:
 Initializes an already allocated OFNumber with the specified short.
 
(instancetype) - initWithInt:
 Initializes an already allocated OFNumber with the specified int.
 
(instancetype) - initWithLong:
 Initializes an already allocated OFNumber with the specified long.
 
(instancetype) - initWithLongLong:
 Initializes an already allocated OFNumber with the specified long long.
 
(instancetype) - initWithUnsignedChar:
 Initializes an already allocated OFNumber with the specified unsigned char.
 
(instancetype) - initWithUnsignedShort:
 Initializes an already allocated OFNumber with the specified unsigned short.
 
(instancetype) - initWithUnsignedInt:
 Initializes an already allocated OFNumber with the specified unsigned int.
 
(instancetype) - initWithUnsignedLong:
 Initializes an already allocated OFNumber with the specified unsigned long.
 
(instancetype) - initWithUnsignedLongLong:
 Initializes an already allocated OFNumber with the specified unsigned long long.
 
(instancetype) - initWithFloat:
 Initializes an already allocated OFNumber with the specified float.
 
(instancetype) - initWithDouble:
 Initializes an already allocated OFNumber with the specified double.
 
(OFComparisonResult- compare:
 Compares the number to another number.
 
- Instance Methods inherited from OFValue
(instancetype) - initWithBytes:objCType:
 Initializes an already allocated OFValue with the specified bytes of the specified type.
 
(void) - getValue:size:
 Gets the value.
 
- 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 <OFComparing>
(OFComparisonResult- compare:
 Compares the object to another object.
 
- Instance Methods inherited from <OFJSONRepresentation>
(OFString *) - JSONRepresentationWithOptions:
 Returns the JSON representation of the object as a string.
 

Class Methods

(instancetype) + valueWithPointer:
 Creates a new, autoreleased OFValue containing the specified pointer.
 
(instancetype) + valueWithNonretainedObject:
 Creates a new, autoreleased OFValue containing the specified non-retained object.
 
(instancetype) + valueWithRange:
 Creates a new, autoreleased OFValue containing the specified range.
 
(instancetype) + valueWithPoint:
 Creates a new, autoreleased OFValue containing the specified point.
 
(instancetype) + valueWithSize:
 Creates a new, autoreleased OFValue containing the specified size.
 
(instancetype) + valueWithRect:
 Creates a new, autoreleased OFValue containing the specified rectangle.
 
(instancetype) + numberWithBool:
 Creates a new OFNumber with the specified bool.
 
(instancetype) + numberWithChar:
 Creates a new OFNumber with the specified signed char.
 
(instancetype) + numberWithShort:
 Creates a new OFNumber with the specified short.
 
(instancetype) + numberWithInt:
 Creates a new OFNumber with the specified int.
 
(instancetype) + numberWithLong:
 Creates a new OFNumber with the specified long.
 
(instancetype) + numberWithLongLong:
 Creates a new OFNumber with the specified long long.
 
(instancetype) + numberWithUnsignedChar:
 Creates a new OFNumber with the specified unsigned char.
 
(instancetype) + numberWithUnsignedShort:
 Creates a new OFNumber with the specified unsigned short.
 
(instancetype) + numberWithUnsignedInt:
 Creates a new OFNumber with the specified unsigned int.
 
(instancetype) + numberWithUnsignedLong:
 Creates a new OFNumber with the specified unsigned long.
 
(instancetype) + numberWithUnsignedLongLong:
 Creates a new OFNumber with the specified unsigned long long.
 
(instancetype) + numberWithFloat:
 Creates a new OFNumber with the specified float.
 
(instancetype) + numberWithDouble:
 Creates a new OFNumber with the specified double.
 
- Class Methods inherited from OFValue
(instancetype) + valueWithBytes:objCType:
 Creates a new, autorelease OFValue with the specified bytes of the specified type.
 
(instancetype) + valueWithVector3D:
 Creates a new, autoreleased OFValue containing the specified 3D vector.
 
(instancetype) + valueWithVector4D:
 Creates a new, autoreleased OFValue containing the specified 4D vector.
 
- 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

bool boolValue
 The OFNumber as a bool.
 
signed char charValue
 The OFNumber as a signed char.
 
short shortValue
 The OFNumber as a short.
 
int intValue
 The OFNumber as an int.
 
long longValue
 The OFNumber as a long.
 
long long longLongValue
 The OFNumber as a long long.
 
unsigned char unsignedCharValue
 The OFNumber as an unsigned char.
 
unsigned short unsignedShortValue
 The OFNumber as an unsigned short.
 
unsigned int unsignedIntValue
 The OFNumber as an unsigned int.
 
unsigned long unsignedLongValue
 The OFNumber as an unsigned long.
 
unsigned long long unsignedLongLongValue
 The OFNumber as an unsigned long long.
 
float floatValue
 The OFNumber as a float.
 
double doubleValue
 The OFNumber as a double.
 
OFStringstringValue
 The OFNumber as a string.
 
- Properties inherited from OFValue
const char * objCType
 The ObjC type encoding of the value.
 
void * pointerValue
 The value as a pointer to void.
 
id nonretainedObjectValue
 The value as a non-retained object.
 
OFRange rangeValue
 The value as an OFRange.
 
OFPoint pointValue
 The value as an OFPoint.
 
OFSize sizeValue
 The value as an OFSize.
 
OFRect rectValue
 The value as an OFRect.
 
OFVector3D vector3DValue
 The value as an OFVector3D.
 
OFVector4D vector4DValue
 The value as an OFVector4D.
 
- Properties inherited from OFObject
OFStringclassName
 The name of the object's class.
 
OFStringdescription
 A description for the object.
 
- 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

Provides a way to store a number in an object.

Method Documentation

◆ compare:

- (OFComparisonResult) compare: (OFNumber *) number

Compares the number to another number.

Parameters
numberThe number to compare the number to
Returns
The result of the comparison

◆ initWithBool:

- (instancetype) initWithBool: (bool) value

Initializes an already allocated OFNumber with the specified bool.

Parameters
valueThe bool value which the OFNumber should contain
Returns
An initialized OFNumber

◆ initWithChar:

- (instancetype) initWithChar: (signed char) value

Initializes an already allocated OFNumber with the specified signed char.

Parameters
valueThe signed char value which the OFNumber should contain
Returns
An initialized OFNumber

◆ initWithDouble:

- (instancetype) initWithDouble: (double) value

Initializes an already allocated OFNumber with the specified double.

Parameters
valueThe double value which the OFNumber should contain
Returns
An initialized OFNumber

◆ initWithFloat:

- (instancetype) initWithFloat: (float) value

Initializes an already allocated OFNumber with the specified float.

Parameters
valueThe float value which the OFNumber should contain
Returns
An initialized OFNumber

◆ initWithInt:

- (instancetype) initWithInt: (int) value

Initializes an already allocated OFNumber with the specified int.

Parameters
valueThe int value which the OFNumber should contain
Returns
An initialized OFNumber

◆ initWithLong:

- (instancetype) initWithLong: (long) value

Initializes an already allocated OFNumber with the specified long.

Parameters
valueThe long value which the OFNumber should contain
Returns
An initialized OFNumber

◆ initWithLongLong:

- (instancetype) initWithLongLong: (long long) value

Initializes an already allocated OFNumber with the specified long long.

Parameters
valueThe long long value which the OFNumber should contain
Returns
An initialized OFNumber

◆ initWithShort:

- (instancetype) initWithShort: (short) value

Initializes an already allocated OFNumber with the specified short.

Parameters
valueThe short value which the OFNumber should contain
Returns
An initialized OFNumber

◆ initWithUnsignedChar:

- (instancetype) initWithUnsignedChar: (unsigned char) value

Initializes an already allocated OFNumber with the specified unsigned char.

Parameters
valueThe unsigned char value which the OFNumber should contain
Returns
An initialized OFNumber

◆ initWithUnsignedInt:

- (instancetype) initWithUnsignedInt: (unsigned int) value

Initializes an already allocated OFNumber with the specified unsigned int.

Parameters
valueThe unsigned int value which the OFNumber should contain
Returns
An initialized OFNumber

◆ initWithUnsignedLong:

- (instancetype) initWithUnsignedLong: (unsigned long) value

Initializes an already allocated OFNumber with the specified unsigned long.

Parameters
valueThe unsigned long value which the OFNumber should contain
Returns
An initialized OFNumber

◆ initWithUnsignedLongLong:

- (instancetype) initWithUnsignedLongLong: (unsigned long long) value

Initializes an already allocated OFNumber with the specified unsigned long long.

Parameters
valueThe unsigned long long value which the OFNumber should contain
Returns
An initialized OFNumber

◆ initWithUnsignedShort:

- (instancetype) initWithUnsignedShort: (unsigned short) value

Initializes an already allocated OFNumber with the specified unsigned short.

Parameters
valueThe unsigned short value which the OFNumber should contain
Returns
An initialized OFNumber

◆ numberWithBool:

+ (instancetype) numberWithBool: (bool) value

Creates a new OFNumber with the specified bool.

Parameters
valueThe bool value which the OFNumber should contain
Returns
A new autoreleased OFNumber

◆ numberWithChar:

+ (instancetype) numberWithChar: (signed char) value

Creates a new OFNumber with the specified signed char.

Parameters
valueThe signed char value which the OFNumber should contain
Returns
A new autoreleased OFNumber

◆ numberWithDouble:

+ (instancetype) numberWithDouble: (double) value

Creates a new OFNumber with the specified double.

Parameters
valueThe double value which the OFNumber should contain
Returns
A new autoreleased OFNumber

◆ numberWithFloat:

+ (instancetype) numberWithFloat: (float) value

Creates a new OFNumber with the specified float.

Parameters
valueThe float value which the OFNumber should contain
Returns
A new autoreleased OFNumber

◆ numberWithInt:

+ (instancetype) numberWithInt: (int) value

Creates a new OFNumber with the specified int.

Parameters
valueThe int value which the OFNumber should contain
Returns
A new autoreleased OFNumber

◆ numberWithLong:

+ (instancetype) numberWithLong: (long) value

Creates a new OFNumber with the specified long.

Parameters
valueThe long value which the OFNumber should contain
Returns
A new autoreleased OFNumber

◆ numberWithLongLong:

+ (instancetype) numberWithLongLong: (long long) value

Creates a new OFNumber with the specified long long.

Parameters
valueThe long long value which the OFNumber should contain
Returns
A new autoreleased OFNumber

◆ numberWithShort:

+ (instancetype) numberWithShort: (short) value

Creates a new OFNumber with the specified short.

Parameters
valueThe short value which the OFNumber should contain
Returns
A new autoreleased OFNumber

◆ numberWithUnsignedChar:

+ (instancetype) numberWithUnsignedChar: (unsigned char) value

Creates a new OFNumber with the specified unsigned char.

Parameters
valueThe unsigned char value which the OFNumber should contain
Returns
A new autoreleased OFNumber

◆ numberWithUnsignedInt:

+ (instancetype) numberWithUnsignedInt: (unsigned int) value

Creates a new OFNumber with the specified unsigned int.

Parameters
valueThe unsigned int value which the OFNumber should contain
Returns
A new autoreleased OFNumber

◆ numberWithUnsignedLong:

+ (instancetype) numberWithUnsignedLong: (unsigned long) value

Creates a new OFNumber with the specified unsigned long.

Parameters
valueThe unsigned long value which the OFNumber should contain
Returns
A new autoreleased OFNumber

◆ numberWithUnsignedLongLong:

+ (instancetype) numberWithUnsignedLongLong: (unsigned long long) value

Creates a new OFNumber with the specified unsigned long long.

Parameters
valueThe unsigned long long value which the OFNumber should contain
Returns
A new autoreleased OFNumber

◆ numberWithUnsignedShort:

+ (instancetype) numberWithUnsignedShort: (unsigned short) value

Creates a new OFNumber with the specified unsigned short.

Parameters
valueThe unsigned short value which the OFNumber should contain
Returns
A new autoreleased OFNumber

◆ 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

Reimplemented from OFValue.

◆ valueWithPoint:

+ (instancetype) valueWithPoint: (OFPoint) point

Creates a new, autoreleased OFValue containing the specified point.

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

Reimplemented from 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

Reimplemented from OFValue.

◆ valueWithRange:

+ (instancetype) valueWithRange: (OFRange) range

Creates a new, autoreleased OFValue containing the specified range.

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

Reimplemented from OFValue.

◆ valueWithRect:

+ (instancetype) valueWithRect: (OFRect) rect

Creates a new, autoreleased OFValue containing the specified rectangle.

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

Reimplemented from OFValue.

◆ valueWithSize:

+ (instancetype) valueWithSize: (OFSize) size

Creates a new, autoreleased OFValue containing the specified size.

Parameters
sizeThe size the OFValue should contain
Returns
A new, autoreleased OFValue

Reimplemented from OFValue.


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