// Copyright 2012 Google Inc. #import #import NS_ASSUME_NONNULL_BEGIN /** * 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. */ @interface NSDictionary (GCKAdditions) /** * Looks up an NSString value for a key, with a given * fallback value. * * @param key The key. * @param defaultValue The default value to return if the key is not found or if its value is not * an NSString. * @return The value of the key, if it was found and was an * NSString; otherwise the default value. */ - (nullable NSString *)gck_stringForKey:(NSString *)key withDefaultValue:(nullable NSString *)defaultValue; /** * Looks up an NSString value for a key, with a fallback * value of nil. * * @param key The key. * @return The value of the key, if found it was found and was an * NSString; otherwise nil. */ - (nullable NSString *)gck_stringForKey:(NSString *)key; /** * Looks up an NSInteger value for a key, with a given * fallback value. * * @param key The key. * @param defaultValue The default value to return if the key is not found or if its value is not * an NSNumber. * @return The value of the key, if it was found and was an * NSNumber; otherwise the default value. */ - (NSInteger)gck_integerForKey:(NSString *)key withDefaultValue:(NSInteger)defaultValue; /** * Looks up an NSUInteger value for a key, with a given * fallback value. * * @param key The key. * @param defaultValue The default value to return if the key is not found or if its value is not * an NSNumber. * @return The value of the key, if it was found and was an * NSNumber; otherwise the default value. */ - (NSUInteger)gck_uintegerForKey:(NSString *)key withDefaultValue:(NSUInteger)defaultValue; /** * Looks up an NSInteger value for a key, with a fallback * value of 0. * * @param key The key. * @return The value of the key, if it was found and was an * NSNumber; otherwise 0. */ - (NSInteger)gck_integerForKey:(NSString *)key; /** * Looks up an NSUInteger value for a key, with a * fallback value of 0. * * @param key The key. * @return The value of the key, if it was found and was an * NSNumber; otherwise 0. */ - (NSUInteger)gck_uintegerForKey:(NSString *)key; /** * Looks up a double value for a key, with a given fallback value. * * @param key The key. * @param defaultValue The default value to return if the key is not found or if its value is not * an NSNumber. * @return The value of the key, if it was found and was an * NSNumber; otherwise the default value. */ - (double)gck_doubleForKey:(NSString *)key withDefaultValue:(double)defaultValue; /** * Looks up a double value for a key, with a fallback value of 0.0. * * @param key The key. * @return The value of the key, if it was found and was an * NSNumber; otherwise 0.0. */ - (double)gck_doubleForKey:(NSString *)key; /** * Looks up a BOOL value for a key, with a given fallback value. * * @param key The key. * @param defaultValue The default value to return if the key is not found or if its value is not * an NSNumber. * @return The value of the key, if it was found and was an * NSNumber; otherwise the default value. */ - (BOOL)gck_boolForKey:(NSString *)key withDefaultValue:(BOOL)defaultValue; /** * Looks up a BOOL value for a key, with a fallback value of NO. * * @param key The key. * @return The value of the key, if it was found and was an * NSNumber; otherwise NO. */ - (BOOL)gck_boolForKey:(NSString *)key; /** * Looks up an NSDictionary value for a key, with a * fallback value of nil. * * @param key The key. * @return The value of the key, if it was found and was an * NSDictionary; otherwise nil. */ - (nullable NSDictionary *)gck_dictionaryForKey:(NSString *)key; /** * Looks up an NSArray value for a key, with a fallback * value of nil. * * @param key The key. * @return The value of the key, if it was found and was an * NSArray; otherwise nil. */ - (nullable NSArray *)gck_arrayForKey:(NSString *)key; /** * Looks up an NSURL value for a key, with a fallback * value of nil. * * @param key The key. * @return The value of the key as an NSURL, if it was * found and was an NSString; otherwise nil. */ - (nullable NSURL *)gck_urlForKey:(NSString *)key; @end NS_ASSUME_NONNULL_END // For backwards compatibility: #ifndef GCKTypedValueLookup #define GCKTypedValueLookup GCKAdditions #endif