NSDictionary(GCKAdditions) Category Reference

A category that adds some convenience methods to NSDictionary for safely looking up values of various types. More...

#import <NSDictionary+GCKAdditions.h>

Instance Methods
(NSString *GCK_NULLABLE_TYPE)	- gck_stringForKey:withDefaultValue:
	Looks up an NSString value for a key, with a given fallback value. More...
(NSString *GCK_NULLABLE_TYPE)	- gck_stringForKey:
	Looks up an NSString value for a key, with a fallback value of nil. More...
(NSInteger)	- gck_integerForKey:withDefaultValue:
	Looks up an NSInteger value for a key, with a given fallback value. More...
(NSUInteger)	- gck_uintegerForKey:withDefaultValue:
	Looks up an NSUInteger value for a key, with a given fallback value. More...
(NSInteger)	- gck_integerForKey:
	Looks up an NSInteger value for a key, with a fallback value of 0. More...
(NSUInteger)	- gck_uintegerForKey:
	Looks up an NSUInteger value for a key, with a fallback value of 0. More...
(double)	- gck_doubleForKey:withDefaultValue:
	Looks up a double value for a key, with a given fallback value. More...
(double)	- gck_doubleForKey:
	Looks up a double value for a key, with a fallback value of 0.0. More...
(BOOL)	- gck_boolForKey:withDefaultValue:
	Looks up a BOOL value for a key, with a given fallback value. More...
(BOOL)	- gck_boolForKey:
	Looks up a BOOL value for a key, with a fallback value of NO. More...
(NSDictionary *GCK_NULLABLE_TYPE)	- gck_dictionaryForKey:
	Looks up an NSDictionary value for a key, with a fallback value of nil. More...
(NSArray *GCK_NULLABLE_TYPE)	- gck_arrayForKey:
	Looks up an NSArray value for a key, with a fallback value of nil. More...
(NSURL *GCK_NULLABLE_TYPE)	- gck_urlForKey:
	Looks up an NSURL value for a key, with a fallback value of nil. More...

Detailed Description

A category that adds some convenience methods to NSDictionary for safely looking up values of various types.

These methods are particularly useful for getting and setting fields of JSON data objects.

Method Documentation

- (NSArray *GCK_NULLABLE_TYPE) gck_arrayForKey:

(NSString *)

key

Looks up an NSArray value for a key, with a fallback value of nil.

Parameters

key

The key.

Returns

The value of the key, if it was found and was an NSArray; otherwise nil.

- (BOOL) gck_boolForKey:

(NSString *)

key

Looks up a BOOL value for a key, with a fallback value of NO.

Parameters

key

The key.

Returns

The value of the key, if it was found and was an NSNumber; otherwise NO.

- (BOOL) gck_boolForKey:		(NSString *)	key
withDefaultValue:		(BOOL)	defaultValue

Looks up a BOOL value for a key, with a given fallback value.

Parameters

key	The key.
defaultValue	The default value to return if the key is not found or if its value is not an NSNumber.

Returns

The value of the key, if it was found and was an NSNumber; otherwise the default value.

- (NSDictionary *GCK_NULLABLE_TYPE) gck_dictionaryForKey:

(NSString *)

key

Looks up an NSDictionary value for a key, with a fallback value of nil.

Parameters

key

The key.

Returns

The value of the key, if it was found and was an NSDictionary; otherwise nil.

- (double) gck_doubleForKey:

(NSString *)

key

Looks up a double value for a key, with a fallback value of 0.0.

Parameters

key

The key.

Returns

The value of the key, if it was found and was an NSNumber; otherwise 0.0.

- (double) gck_doubleForKey:		(NSString *)	key
withDefaultValue:		(double)	defaultValue

Looks up a double value for a key, with a given fallback value.

Parameters

key	The key.
defaultValue	The default value to return if the key is not found or if its value is not an NSNumber.

Returns

The value of the key, if it was found and was an NSNumber; otherwise the default value.

- (NSInteger) gck_integerForKey:

(NSString *)

key

Looks up an NSInteger value for a key, with a fallback value of 0.

Parameters

key

The key.

Returns

The value of the key, if it was found and was an NSNumber; otherwise 0.

- (NSInteger) gck_integerForKey:		(NSString *)	key
withDefaultValue:		(NSInteger)	defaultValue

Looks up an NSInteger value for a key, with a given fallback value.

Parameters

key	The key.
defaultValue	The default value to return if the key is not found or if its value is not an NSNumber.

Returns

The value of the key, if it was found and was an NSNumber; otherwise the default value.

- (NSString *GCK_NULLABLE_TYPE) gck_stringForKey:

(NSString *)

key

Looks up an NSString value for a key, with a fallback value of nil.

Parameters

key

The key.

Returns

The value of the key, if found it was found and was an NSString; otherwise nil.

- (NSString *GCK_NULLABLE_TYPE) gck_stringForKey:		(NSString *)	key
withDefaultValue:		(NSString *GCK_NULLABLE_TYPE)	defaultValue

Looks up an NSString value for a key, with a given fallback value.

Parameters

key	The key.
defaultValue	The default value to return if the key is not found or if its value is not an NSString.

Returns

The value of the key, if it was found and was an NSString; otherwise the default value.

- (NSUInteger) gck_uintegerForKey:

(NSString *)

key

Looks up an NSUInteger value for a key, with a fallback value of 0.

Parameters

key

The key.

Returns

The value of the key, if it was found and was an NSNumber; otherwise 0.

- (NSUInteger) gck_uintegerForKey:		(NSString *)	key
withDefaultValue:		(NSUInteger)	defaultValue

Looks up an NSUInteger value for a key, with a given fallback value.

Parameters

key	The key.
defaultValue	The default value to return if the key is not found or if its value is not an NSNumber.

Returns

The value of the key, if it was found and was an NSNumber; otherwise the default value.

- (NSURL *GCK_NULLABLE_TYPE) gck_urlForKey:

(NSString *)

key

Looks up an NSURL value for a key, with a fallback value of nil.

Parameters

key

The key.

Returns

The value of the key as an NSURL, if it was found and was an NSString; otherwise nil.

---

The documentation for this category was generated from the following file:

• NSDictionary+GCKAdditions.h