Class: NSNumber
Overview
NSNumber is a subclass of NSValue that offers a value as any C scalar (numeric) type. It defines a set of methods specifically for setting and accessing the value as a signed or unsigned char, short int, int, long int, long long int, float, or double or as a BOOL. (Note that number objects do not necessarily preserve the type they are created with.) It also defines a compare: method to determine the ordering of two NSNumber objects.
Direct Known Subclasses
Class Method Summary (collapse)
-
+ numberWithBool:
Creates and returns an NSNumber object containing a given value, treating it as a BOOL.
-
+ numberWithChar:
Creates and returns an NSNumber object containing a given value, treating it as a signed char.
-
+ numberWithDouble:
Creates and returns an NSNumber object containing a given value, treating it as a double.
-
+ numberWithFloat:
Creates and returns an NSNumber object containing a given value, treating it as a float.
-
+ numberWithInt:
Creates and returns an NSNumber object containing a given value, treating it as a signed int.
-
+ numberWithInteger:
Creates and returns an NSNumber object containing a given value, treating it as an NSInteger.
-
+ numberWithLong:
Creates and returns an NSNumber object containing a given value, treating it as a signed long.
-
+ numberWithLongLong:
Creates and returns an NSNumber object containing a given value, treating it as a signed long long.
-
+ numberWithShort:
Creates and returns an NSNumber object containing value, treating it as a signed short.
-
+ numberWithUnsignedChar:
Creates and returns an NSNumber object containing a given value, treating it as an unsigned char.
-
+ numberWithUnsignedInt:
Creates and returns an NSNumber object containing a given value, treating it as an unsigned int.
-
+ numberWithUnsignedInteger:
Creates and returns an NSNumber object containing a given value, treating it as an NSUInteger.
-
+ numberWithUnsignedLong:
Creates and returns an NSNumber object containing a given value, treating it as an unsigned long.
-
+ numberWithUnsignedLongLong:
Creates and returns an NSNumber object containing a given value, treating it as an unsigned long long.
-
+ numberWithUnsignedShort:
Creates and returns an NSNumber object containing a given value, treating it as an unsigned short.
Instance Method Summary (collapse)
-
- boolValue
Returns the receiver’s value as a BOOL.
-
- charValue
Returns the receiver’s value as a char.
-
- compare:
Returns an NSComparisonResult value that indicates whether the receiver is greater than, equal to, or less than a given number.
-
- decimalValue
Returns the receiver’s value, expressed as an NSDecimal structure.
-
- descriptionWithLocale:
Returns a string that represents the contents of the receiver for a given locale.
-
- doubleValue
Returns the receiver’s value as a double.
-
- floatValue
Returns the receiver’s value as a float.
-
- initWithBool:
Returns an NSNumber object initialized to contain a given value, treated as a BOOL.
-
- initWithChar:
Returns an NSNumber object initialized to contain a given value, treated as a signed char.
-
- initWithDouble:
Returns an NSNumber object initialized to contain value, treated as a double.
-
- initWithFloat:
Returns an NSNumber object initialized to contain a given value, treated as a float.
-
- initWithInt:
Returns an NSNumber object initialized to contain a given value, treated as a signed int.
-
- initWithInteger:
Returns an NSNumber object initialized to contain a given value, treated as an NSInteger.
-
- initWithLong:
Returns an NSNumber object initialized to contain a given value, treated as a signed long.
-
- initWithLongLong:
Returns an NSNumber object initialized to contain value, treated as a signed long long.
-
- initWithShort:
Returns an NSNumber object initialized to contain a given value, treated as a signed short.
-
- initWithUnsignedChar:
Returns an NSNumber object initialized to contain a given value, treated as an unsigned char.
-
- initWithUnsignedInt:
Returns an NSNumber object initialized to contain a given value, treated as an unsigned int.
-
- initWithUnsignedInteger:
Returns an NSNumber object initialized to contain a given value, treated as an NSUInteger.
-
- initWithUnsignedLong:
Returns an NSNumber object initialized to contain a given value, treated as an unsigned long.
-
- initWithUnsignedLongLong:
Returns an NSNumber object initialized to contain a given value, treated as an unsigned long long.
-
- initWithUnsignedShort:
Returns an NSNumber object initialized to contain a given value, treated as an unsigned short.
-
- integerValue
Returns the receiver’s value as an NSInteger.
-
- intValue
Returns the receiver’s value as an int.
-
- isEqualToNumber:
Returns a Boolean value that indicates whether the receiver and a given number are equal.
-
- longLongValue
Returns the receiver’s value as a long long.
-
- longValue
Returns the receiver’s value as a long.
-
- objCType
Returns a C string containing the Objective-C type of the data contained in the receiver.
-
- shortValue
Returns the receiver’s value as a short.
-
- stringValue
Returns the receiver’s value as a human-readable string.
-
- unsignedCharValue
Returns the receiver’s value as an unsigned char.
-
- unsignedIntegerValue
Returns the receiver’s value as an NSUInteger.
-
- unsignedIntValue
Returns the receiver’s value as an unsigned int.
-
- unsignedLongLongValue
Returns the receiver’s value as an unsigned long long.
-
- unsignedLongValue
Returns the receiver’s value as an unsigned long.
-
- unsignedShortValue
Returns the receiver’s value as an unsigned short.
Methods inherited from NSValue
#getValue:, #initWithBytes:objCType:, #isEqualToValue:, #nonretainedObjectValue, #pointerValue, #rangeValue, value:withObjCType:, valueWithBytes:objCType:, valueWithNonretainedObject:, valueWithPointer:, valueWithRange:
Methods inherited from NSObject
#!, #!=, #!~, #, #==, #===, #=~, #Rational, #__callee__, #__method__, #__send__, #__type__, `, alloc, allocWithZone:, #autoContentAccessingProxy, autoload, autoload?, autorelease_pool, #awakeAfterUsingCoder:, binding, block_given?, caller, cancelPreviousPerformRequestsWithTarget:, cancelPreviousPerformRequestsWithTarget:selector:object:, catch, class, classFallbacksForKeyedArchiver, #classForCoder, #classForKeyedArchiver, classForKeyedUnarchiver, #clone, conformsToProtocol:, #copy, copyWithZone:, #dealloc, #define_singleton_method, description, display, #doesNotRecognizeSelector:, #dup, #enum_for, #eql?, #equal?, #extend, fail, #finalize, format, #forwardInvocation:, #forwardingTargetForSelector:, framework, #freeze, #frozen?, getpass, gets, global_variables, #init, initialize, #initialize_clone, #initialize_copy, #initialize_dup, #inspect, instanceMethodForSelector:, instanceMethodSignatureForSelector:, #instance_eval, #instance_exec, #instance_of?, #instance_variable_defined?, #instance_variable_get, #instance_variable_set, #instance_variables, instancesRespondToSelector:, isSubclassOfClass:, #is_a?, iterator?, #kind_of?, lambda, load, load_bridge_support_file, load_plist, local_variables, loop, #method, #methodForSelector:, #methodSignatureForSelector:, #methods, #mutableCopy, mutableCopyWithZone:, new, #nil?, open, p, #performSelector:onThread:withObject:waitUntilDone:, #performSelector:onThread:withObject:waitUntilDone:modes:, #performSelector:withObject:afterDelay:, #performSelector:withObject:afterDelay:inModes:, #performSelectorInBackground:withObject:, #performSelectorOnMainThread:withObject:waitUntilDone:, #performSelectorOnMainThread:withObject:waitUntilDone:modes:, print, printf, #private_methods, proc, #protected_methods, #public_method, #public_methods, #public_send, putc, puts, raise, rand, readline, readlines, #replacementObjectForCoder:, #replacementObjectForKeyedArchiver:, require, resolveClassMethod:, resolveInstanceMethod:, #respond_to?, #respond_to_missing?, select, #send, setVersion:, #singleton_methods, sprintf, srand, superclass, #taint, #tainted?, #tap, test, throw, #to_plist, #to_s, trace_var, trap, #trust, #untaint, untrace_var, #untrust, #untrusted?, version
Constructor Details
This class inherits a constructor from NSObject
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class NSObject
Class Method Details
+ (NSNumber) numberWithBool(value)
Creates and returns an NSNumber object containing a given value, treating it as a BOOL.
+ (NSNumber) numberWithChar(value)
Creates and returns an NSNumber object containing a given value, treating it as a signed char.
+ (NSNumber) numberWithDouble(value)
Creates and returns an NSNumber object containing a given value, treating it as a double.
+ (NSNumber) numberWithFloat(value)
Creates and returns an NSNumber object containing a given value, treating it as a float.
+ (NSNumber) numberWithInt(value)
Creates and returns an NSNumber object containing a given value, treating it as a signed int.
+ (NSNumber) numberWithInteger(value)
Creates and returns an NSNumber object containing a given value, treating it as an NSInteger.
+ (NSNumber) numberWithLong(value)
Creates and returns an NSNumber object containing a given value, treating it as a signed long.
+ (NSNumber) numberWithLongLong(value)
Creates and returns an NSNumber object containing a given value, treating it as a signed long long.
+ (NSNumber) numberWithShort(value)
Creates and returns an NSNumber object containing value, treating it as a signed short.
+ (NSNumber) numberWithUnsignedChar(value)
Creates and returns an NSNumber object containing a given value, treating it as an unsigned char.
+ (NSNumber) numberWithUnsignedInt(value)
Creates and returns an NSNumber object containing a given value, treating it as an unsigned int.
+ (NSNumber) numberWithUnsignedInteger(value)
Creates and returns an NSNumber object containing a given value, treating it as an NSUInteger.
+ (NSNumber) numberWithUnsignedLong(value)
Creates and returns an NSNumber object containing a given value, treating it as an unsigned long.
Instance Method Details
- (Boolean) boolValue
Returns the receiver’s value as a BOOL.
- (Integer) charValue
Returns the receiver’s value as a char.
- (NSComparisonResult) compare(aNumber)
Returns an NSComparisonResult value that indicates whether the receiver is greater than, equal to, or less than a given number. The compare: method follows the standard C rules for type conversion. For example, if you compare an NSNumber object that has an integer value with an NSNumber object that has a floating point value, the integer value is converted to a floating-point value for comparison.
- (String) descriptionWithLocale(aLocale)
Returns a string that represents the contents of the receiver for a given locale. For example, if you have an NSNumber object that has the integer value 522, sending it the descriptionWithLocale: message returns the string “522”. To obtain the string representation, this method invokes NSString’s initWithFormat:locale: method, supplying the format based on the type the NSNumber object was created with:Data Type Format Specification char %i double %0.16g float %0.7g int %i long %li long long %lli short %hi unsigned char %u unsigned int %u unsigned long %lu unsigned long long %llu unsigned short %hu
- (Float) doubleValue
Returns the receiver’s value as a double.
- (Float) floatValue
Returns the receiver’s value as a float.
- (Object) initWithBool(value)
Returns an NSNumber object initialized to contain a given value, treated as a BOOL.
- (Object) initWithChar(value)
Returns an NSNumber object initialized to contain a given value, treated as a signed char.
- (Object) initWithDouble(value)
Returns an NSNumber object initialized to contain value, treated as a double.
- (Object) initWithFloat(value)
Returns an NSNumber object initialized to contain a given value, treated as a float.
- (Object) initWithInt(value)
Returns an NSNumber object initialized to contain a given value, treated as a signed int.
- (Object) initWithInteger(value)
Returns an NSNumber object initialized to contain a given value, treated as an NSInteger.
- (Object) initWithLong(value)
Returns an NSNumber object initialized to contain a given value, treated as a signed long.
- (Object) initWithLongLong(value)
Returns an NSNumber object initialized to contain value, treated as a signed long long.
- (Object) initWithShort(value)
Returns an NSNumber object initialized to contain a given value, treated as a signed short.
- (Object) initWithUnsignedChar(value)
Returns an NSNumber object initialized to contain a given value, treated as an unsigned char.
- (Object) initWithUnsignedInt(value)
Returns an NSNumber object initialized to contain a given value, treated as an unsigned int.
- (Object) initWithUnsignedInteger(value)
Returns an NSNumber object initialized to contain a given value, treated as an NSUInteger.
- (Object) initWithUnsignedLong(value)
Returns an NSNumber object initialized to contain a given value, treated as an unsigned long.
- (Object) initWithUnsignedLongLong(value)
Returns an NSNumber object initialized to contain a given value, treated as an unsigned long long.
- (Object) initWithUnsignedShort(value)
Returns an NSNumber object initialized to contain a given value, treated as an unsigned short.
- (Integer) integerValue
Returns the receiver’s value as an NSInteger.
- (Integer) intValue
Returns the receiver’s value as an int.
- (Boolean) isEqualToNumber(aNumber)
Returns a Boolean value that indicates whether the receiver and a given number are equal. Two NSNumber objects are considered equal if they have the same id values or if they have equivalent values (as determined by the compare: method).This method is more efficient than compare: if you know the two objects are numbers.
- (Integer) longLongValue
Returns the receiver’s value as a long long.
- (Integer) longValue
Returns the receiver’s value as a long.
- (const char) objCType
Returns a C string containing the Objective-C type of the data contained in the receiver.
- (Integer) shortValue
Returns the receiver’s value as a short.
- (String) stringValue
Returns the receiver’s value as a human-readable string.
- (Integer) unsignedCharValue
Returns the receiver’s value as an unsigned char.
- (Integer) unsignedIntegerValue
Returns the receiver’s value as an NSUInteger.
- (unsigned int) unsignedIntValue
Returns the receiver’s value as an unsigned int.
- (Integer) unsignedLongLongValue
Returns the receiver’s value as an unsigned long long.
- (Integer) unsignedLongValue
Returns the receiver’s value as an unsigned long.
- (Integer) unsignedShortValue
Returns the receiver’s value as an unsigned short.