Index: third_party/protobuf/objectivec/GPBDictionary.h |
diff --git a/third_party/protobuf/objectivec/GPBDictionary.h b/third_party/protobuf/objectivec/GPBDictionary.h |
index 3120814a633a58fa87958c69efbbb53cf62cc8a0..4b2b9ff34b739500f7e629300acab8e65820a99e 100644 |
--- a/third_party/protobuf/objectivec/GPBDictionary.h |
+++ b/third_party/protobuf/objectivec/GPBDictionary.h |
@@ -32,10 +32,14 @@ |
#import "GPBRuntimeTypes.h" |
-// These classes are used for map fields of basic data types. They are used because |
-// they perform better than boxing into NSNumbers in NSDictionaries. |
- |
-// Note: These are not meant to be subclassed. |
+// Note on naming: for the classes holding numeric values, a more natural |
+// naming of the method might be things like "-valueForKey:", |
+// "-setValue:forKey:"; etc. But those selectors are also defined by Key Value |
+// Coding (KVC) as categories on NSObject. So "overloading" the selectors with |
+// other meanings can cause warnings (based on compiler settings), but more |
+// importantly, some of those selector get called as KVC breaks up keypaths. |
+// So if those selectors are used, using KVC will compile cleanly, but could |
+// crash as it invokes those selectors with the wrong types of arguments. |
NS_ASSUME_NONNULL_BEGIN |
@@ -44,275 +48,1134 @@ NS_ASSUME_NONNULL_BEGIN |
#pragma mark - UInt32 -> UInt32 |
+/** |
+ * Class used for map fields of <uint32_t, uint32_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBUInt32UInt32Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(uint32_t)value |
- forKey:(uint32_t)key; |
-+ (instancetype)dictionaryWithValues:(const uint32_t [])values |
- forKeys:(const uint32_t [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt32:(uint32_t)value |
+ forKey:(uint32_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt32s:(const uint32_t [])values |
+ forKeys:(const uint32_t [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBUInt32UInt32Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const uint32_t [])values |
- forKeys:(const uint32_t [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithUInt32s:(const uint32_t [])values |
+ forKeys:(const uint32_t [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBUInt32UInt32Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(uint32_t)key value:(nullable uint32_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getUInt32:(nullable uint32_t *)value forKey:(uint32_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndUInt32sUsingBlock: |
(void (^)(uint32_t key, uint32_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBUInt32UInt32Dictionary *)otherDictionary; |
-- (void)setValue:(uint32_t)value forKey:(uint32_t)key; |
- |
-- (void)removeValueForKey:(uint32_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setUInt32:(uint32_t)value forKey:(uint32_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeUInt32ForKey:(uint32_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - UInt32 -> Int32 |
+/** |
+ * Class used for map fields of <uint32_t, int32_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBUInt32Int32Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(int32_t)value |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithInt32:(int32_t)value |
forKey:(uint32_t)key; |
-+ (instancetype)dictionaryWithValues:(const int32_t [])values |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithInt32s:(const int32_t [])values |
forKeys:(const uint32_t [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBUInt32Int32Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const int32_t [])values |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithInt32s:(const int32_t [])values |
forKeys:(const uint32_t [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBUInt32Int32Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(uint32_t)key value:(nullable int32_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getInt32:(nullable int32_t *)value forKey:(uint32_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndInt32sUsingBlock: |
(void (^)(uint32_t key, int32_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBUInt32Int32Dictionary *)otherDictionary; |
-- (void)setValue:(int32_t)value forKey:(uint32_t)key; |
- |
-- (void)removeValueForKey:(uint32_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setInt32:(int32_t)value forKey:(uint32_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeInt32ForKey:(uint32_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - UInt32 -> UInt64 |
+/** |
+ * Class used for map fields of <uint32_t, uint64_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBUInt32UInt64Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(uint64_t)value |
- forKey:(uint32_t)key; |
-+ (instancetype)dictionaryWithValues:(const uint64_t [])values |
- forKeys:(const uint32_t [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt64:(uint64_t)value |
+ forKey:(uint32_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt64s:(const uint64_t [])values |
+ forKeys:(const uint32_t [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBUInt32UInt64Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const uint64_t [])values |
- forKeys:(const uint32_t [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithUInt64s:(const uint64_t [])values |
+ forKeys:(const uint32_t [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBUInt32UInt64Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(uint32_t)key value:(nullable uint64_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getUInt64:(nullable uint64_t *)value forKey:(uint32_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndUInt64sUsingBlock: |
(void (^)(uint32_t key, uint64_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBUInt32UInt64Dictionary *)otherDictionary; |
-- (void)setValue:(uint64_t)value forKey:(uint32_t)key; |
- |
-- (void)removeValueForKey:(uint32_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setUInt64:(uint64_t)value forKey:(uint32_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeUInt64ForKey:(uint32_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - UInt32 -> Int64 |
+/** |
+ * Class used for map fields of <uint32_t, int64_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBUInt32Int64Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(int64_t)value |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithInt64:(int64_t)value |
forKey:(uint32_t)key; |
-+ (instancetype)dictionaryWithValues:(const int64_t [])values |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithInt64s:(const int64_t [])values |
forKeys:(const uint32_t [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBUInt32Int64Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const int64_t [])values |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithInt64s:(const int64_t [])values |
forKeys:(const uint32_t [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBUInt32Int64Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(uint32_t)key value:(nullable int64_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getInt64:(nullable int64_t *)value forKey:(uint32_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndInt64sUsingBlock: |
(void (^)(uint32_t key, int64_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBUInt32Int64Dictionary *)otherDictionary; |
-- (void)setValue:(int64_t)value forKey:(uint32_t)key; |
- |
-- (void)removeValueForKey:(uint32_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setInt64:(int64_t)value forKey:(uint32_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeInt64ForKey:(uint32_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - UInt32 -> Bool |
+/** |
+ * Class used for map fields of <uint32_t, BOOL> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBUInt32BoolDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(BOOL)value |
- forKey:(uint32_t)key; |
-+ (instancetype)dictionaryWithValues:(const BOOL [])values |
- forKeys:(const uint32_t [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithBool:(BOOL)value |
+ forKey:(uint32_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithBools:(const BOOL [])values |
+ forKeys:(const uint32_t [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBUInt32BoolDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const BOOL [])values |
- forKeys:(const uint32_t [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithBools:(const BOOL [])values |
+ forKeys:(const uint32_t [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBUInt32BoolDictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(uint32_t)key value:(nullable BOOL *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getBool:(nullable BOOL *)value forKey:(uint32_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndBoolsUsingBlock: |
(void (^)(uint32_t key, BOOL value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBUInt32BoolDictionary *)otherDictionary; |
-- (void)setValue:(BOOL)value forKey:(uint32_t)key; |
- |
-- (void)removeValueForKey:(uint32_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setBool:(BOOL)value forKey:(uint32_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeBoolForKey:(uint32_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - UInt32 -> Float |
+/** |
+ * Class used for map fields of <uint32_t, float> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBUInt32FloatDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(float)value |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithFloat:(float)value |
forKey:(uint32_t)key; |
-+ (instancetype)dictionaryWithValues:(const float [])values |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithFloats:(const float [])values |
forKeys:(const uint32_t [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBUInt32FloatDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const float [])values |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithFloats:(const float [])values |
forKeys:(const uint32_t [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBUInt32FloatDictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(uint32_t)key value:(nullable float *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getFloat:(nullable float *)value forKey:(uint32_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndFloatsUsingBlock: |
(void (^)(uint32_t key, float value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBUInt32FloatDictionary *)otherDictionary; |
-- (void)setValue:(float)value forKey:(uint32_t)key; |
- |
-- (void)removeValueForKey:(uint32_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setFloat:(float)value forKey:(uint32_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeFloatForKey:(uint32_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - UInt32 -> Double |
+/** |
+ * Class used for map fields of <uint32_t, double> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBUInt32DoubleDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(double)value |
- forKey:(uint32_t)key; |
-+ (instancetype)dictionaryWithValues:(const double [])values |
- forKeys:(const uint32_t [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithDouble:(double)value |
+ forKey:(uint32_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithDoubles:(const double [])values |
+ forKeys:(const uint32_t [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBUInt32DoubleDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const double [])values |
- forKeys:(const uint32_t [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithDoubles:(const double [])values |
+ forKeys:(const uint32_t [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBUInt32DoubleDictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(uint32_t)key value:(nullable double *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getDouble:(nullable double *)value forKey:(uint32_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndDoublesUsingBlock: |
(void (^)(uint32_t key, double value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBUInt32DoubleDictionary *)otherDictionary; |
-- (void)setValue:(double)value forKey:(uint32_t)key; |
- |
-- (void)removeValueForKey:(uint32_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setDouble:(double)value forKey:(uint32_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeDoubleForKey:(uint32_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - UInt32 -> Enum |
+/** |
+ * Class used for map fields of <uint32_t, int32_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBUInt32EnumDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** The validation function to check if the enums are valid. */ |
@property(nonatomic, readonly) GPBEnumValidationFunc validationFunc; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given validation function. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * |
+ * @return A newly instanced dictionary. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param rawValue The raw enum value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
rawValue:(int32_t)rawValue |
forKey:(uint32_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param values The raw enum values values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
rawValues:(const int32_t [])values |
forKeys:(const uint32_t [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBUInt32EnumDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
capacity:(NSUInteger)numItems; |
+/** |
+ * Initializes a dictionary with the given validation function. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * |
+ * @return A newly initialized dictionary. |
+ **/ |
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func; |
+ |
+/** |
+ * Initializes a dictionary with the entries given. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param values The raw enum values values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly initialized dictionary with the keys and values in it. |
+ **/ |
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func |
rawValues:(const int32_t [])values |
forKeys:(const uint32_t [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
- (instancetype)initWithDictionary:(GPBUInt32EnumDictionary *)dictionary; |
+ |
+/** |
+ * Initializes a dictionary with the given capacity. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly initialized dictionary with the given capacity. |
+ **/ |
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func |
capacity:(NSUInteger)numItems; |
@@ -320,19 +1183,63 @@ NS_ASSUME_NONNULL_BEGIN |
// is not a valid enumerator as defined by validationFunc. If the actual value is |
// desired, use "raw" version of the method. |
-- (BOOL)valueForKey:(uint32_t)key value:(nullable int32_t *)value; |
- |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getEnum:(nullable int32_t *)value forKey:(uint32_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndEnumsUsingBlock: |
(void (^)(uint32_t key, int32_t value, BOOL *stop))block; |
-// These methods bypass the validationFunc to provide access to values that were not |
-// known at the time the binary was compiled. |
- |
-- (BOOL)valueForKey:(uint32_t)key rawValue:(nullable int32_t *)rawValue; |
- |
+/** |
+ * Gets the raw enum value for the given key. |
+ * |
+ * @note This method bypass the validationFunc to enable the access of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param rawValue Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getRawValue:(nullable int32_t *)rawValue forKey:(uint32_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @note This method bypass the validationFunc to enable the access of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **rawValue**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
- (void)enumerateKeysAndRawValuesUsingBlock: |
(void (^)(uint32_t key, int32_t rawValue, BOOL *stop))block; |
+/** |
+ * Adds the keys and raw enum values from another dictionary. |
+ * |
+ * @note This method bypass the validationFunc to enable the setting of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addRawEntriesFromDictionary:(GPBUInt32EnumDictionary *)otherDictionary; |
// If value is not a valid enumerator as defined by validationFunc, these |
@@ -340,325 +1247,1312 @@ NS_ASSUME_NONNULL_BEGIN |
// to the default value. Use the rawValue methods below to assign non enumerator |
// values. |
-- (void)setValue:(int32_t)value forKey:(uint32_t)key; |
- |
-// This method bypass the validationFunc to provide setting of values that were not |
-// known at the time the binary was compiled. |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setEnum:(int32_t)value forKey:(uint32_t)key; |
+ |
+/** |
+ * Sets the raw enum value for the given key. |
+ * |
+ * @note This method bypass the validationFunc to enable the setting of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param rawValue The raw enum value to set. |
+ * @param key The key under which to store the raw enum value. |
+ **/ |
- (void)setRawValue:(int32_t)rawValue forKey:(uint32_t)key; |
-// No validation applies to these methods. |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeEnumForKey:(uint32_t)aKey; |
-- (void)removeValueForKey:(uint32_t)aKey; |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - UInt32 -> Object |
+/** |
+ * Class used for map fields of <uint32_t, ObjectType> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBUInt32ObjectDictionary<__covariant ObjectType> : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param object The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
+ (instancetype)dictionaryWithObject:(ObjectType)object |
forKey:(uint32_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param objects The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
+ (instancetype)dictionaryWithObjects:(const ObjectType GPB_UNSAFE_UNRETAINED [])objects |
forKeys:(const uint32_t [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBUInt32ObjectDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param objects The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
- (instancetype)initWithObjects:(const ObjectType GPB_UNSAFE_UNRETAINED [])objects |
forKeys:(const uint32_t [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBUInt32ObjectDictionary *)dictionary; |
+ |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
- (instancetype)initWithCapacity:(NSUInteger)numItems; |
+/** |
+ * Fetches the object stored under the given key. |
+ * |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return The object if found, nil otherwise. |
+ **/ |
- (ObjectType)objectForKey:(uint32_t)key; |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **object**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
- (void)enumerateKeysAndObjectsUsingBlock: |
(void (^)(uint32_t key, ObjectType object, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBUInt32ObjectDictionary *)otherDictionary; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param object The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
- (void)setObject:(ObjectType)object forKey:(uint32_t)key; |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
- (void)removeObjectForKey:(uint32_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Int32 -> UInt32 |
+/** |
+ * Class used for map fields of <int32_t, uint32_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBInt32UInt32Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(uint32_t)value |
- forKey:(int32_t)key; |
-+ (instancetype)dictionaryWithValues:(const uint32_t [])values |
- forKeys:(const int32_t [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt32:(uint32_t)value |
+ forKey:(int32_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt32s:(const uint32_t [])values |
+ forKeys:(const int32_t [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBInt32UInt32Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const uint32_t [])values |
- forKeys:(const int32_t [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithUInt32s:(const uint32_t [])values |
+ forKeys:(const int32_t [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBInt32UInt32Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(int32_t)key value:(nullable uint32_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getUInt32:(nullable uint32_t *)value forKey:(int32_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndUInt32sUsingBlock: |
(void (^)(int32_t key, uint32_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBInt32UInt32Dictionary *)otherDictionary; |
-- (void)setValue:(uint32_t)value forKey:(int32_t)key; |
- |
-- (void)removeValueForKey:(int32_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setUInt32:(uint32_t)value forKey:(int32_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeUInt32ForKey:(int32_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Int32 -> Int32 |
+/** |
+ * Class used for map fields of <int32_t, int32_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBInt32Int32Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(int32_t)value |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithInt32:(int32_t)value |
forKey:(int32_t)key; |
-+ (instancetype)dictionaryWithValues:(const int32_t [])values |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithInt32s:(const int32_t [])values |
forKeys:(const int32_t [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBInt32Int32Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const int32_t [])values |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithInt32s:(const int32_t [])values |
forKeys:(const int32_t [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBInt32Int32Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(int32_t)key value:(nullable int32_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getInt32:(nullable int32_t *)value forKey:(int32_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndInt32sUsingBlock: |
(void (^)(int32_t key, int32_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBInt32Int32Dictionary *)otherDictionary; |
-- (void)setValue:(int32_t)value forKey:(int32_t)key; |
- |
-- (void)removeValueForKey:(int32_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setInt32:(int32_t)value forKey:(int32_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeInt32ForKey:(int32_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Int32 -> UInt64 |
+/** |
+ * Class used for map fields of <int32_t, uint64_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBInt32UInt64Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(uint64_t)value |
- forKey:(int32_t)key; |
-+ (instancetype)dictionaryWithValues:(const uint64_t [])values |
- forKeys:(const int32_t [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt64:(uint64_t)value |
+ forKey:(int32_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt64s:(const uint64_t [])values |
+ forKeys:(const int32_t [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBInt32UInt64Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const uint64_t [])values |
- forKeys:(const int32_t [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithUInt64s:(const uint64_t [])values |
+ forKeys:(const int32_t [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBInt32UInt64Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(int32_t)key value:(nullable uint64_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getUInt64:(nullable uint64_t *)value forKey:(int32_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndUInt64sUsingBlock: |
(void (^)(int32_t key, uint64_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBInt32UInt64Dictionary *)otherDictionary; |
-- (void)setValue:(uint64_t)value forKey:(int32_t)key; |
- |
-- (void)removeValueForKey:(int32_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setUInt64:(uint64_t)value forKey:(int32_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeUInt64ForKey:(int32_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Int32 -> Int64 |
+/** |
+ * Class used for map fields of <int32_t, int64_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBInt32Int64Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(int64_t)value |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithInt64:(int64_t)value |
forKey:(int32_t)key; |
-+ (instancetype)dictionaryWithValues:(const int64_t [])values |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithInt64s:(const int64_t [])values |
forKeys:(const int32_t [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBInt32Int64Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const int64_t [])values |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithInt64s:(const int64_t [])values |
forKeys:(const int32_t [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBInt32Int64Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(int32_t)key value:(nullable int64_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getInt64:(nullable int64_t *)value forKey:(int32_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndInt64sUsingBlock: |
(void (^)(int32_t key, int64_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBInt32Int64Dictionary *)otherDictionary; |
-- (void)setValue:(int64_t)value forKey:(int32_t)key; |
- |
-- (void)removeValueForKey:(int32_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setInt64:(int64_t)value forKey:(int32_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeInt64ForKey:(int32_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Int32 -> Bool |
+/** |
+ * Class used for map fields of <int32_t, BOOL> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBInt32BoolDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(BOOL)value |
- forKey:(int32_t)key; |
-+ (instancetype)dictionaryWithValues:(const BOOL [])values |
- forKeys:(const int32_t [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithBool:(BOOL)value |
+ forKey:(int32_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithBools:(const BOOL [])values |
+ forKeys:(const int32_t [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBInt32BoolDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const BOOL [])values |
- forKeys:(const int32_t [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithBools:(const BOOL [])values |
+ forKeys:(const int32_t [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBInt32BoolDictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(int32_t)key value:(nullable BOOL *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getBool:(nullable BOOL *)value forKey:(int32_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndBoolsUsingBlock: |
(void (^)(int32_t key, BOOL value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBInt32BoolDictionary *)otherDictionary; |
-- (void)setValue:(BOOL)value forKey:(int32_t)key; |
- |
-- (void)removeValueForKey:(int32_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setBool:(BOOL)value forKey:(int32_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeBoolForKey:(int32_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Int32 -> Float |
+/** |
+ * Class used for map fields of <int32_t, float> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBInt32FloatDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(float)value |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithFloat:(float)value |
forKey:(int32_t)key; |
-+ (instancetype)dictionaryWithValues:(const float [])values |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithFloats:(const float [])values |
forKeys:(const int32_t [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBInt32FloatDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const float [])values |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithFloats:(const float [])values |
forKeys:(const int32_t [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBInt32FloatDictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(int32_t)key value:(nullable float *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getFloat:(nullable float *)value forKey:(int32_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndFloatsUsingBlock: |
(void (^)(int32_t key, float value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBInt32FloatDictionary *)otherDictionary; |
-- (void)setValue:(float)value forKey:(int32_t)key; |
- |
-- (void)removeValueForKey:(int32_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setFloat:(float)value forKey:(int32_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeFloatForKey:(int32_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Int32 -> Double |
+/** |
+ * Class used for map fields of <int32_t, double> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBInt32DoubleDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(double)value |
- forKey:(int32_t)key; |
-+ (instancetype)dictionaryWithValues:(const double [])values |
- forKeys:(const int32_t [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithDouble:(double)value |
+ forKey:(int32_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithDoubles:(const double [])values |
+ forKeys:(const int32_t [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBInt32DoubleDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const double [])values |
- forKeys:(const int32_t [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithDoubles:(const double [])values |
+ forKeys:(const int32_t [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBInt32DoubleDictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(int32_t)key value:(nullable double *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getDouble:(nullable double *)value forKey:(int32_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndDoublesUsingBlock: |
(void (^)(int32_t key, double value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBInt32DoubleDictionary *)otherDictionary; |
-- (void)setValue:(double)value forKey:(int32_t)key; |
- |
-- (void)removeValueForKey:(int32_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setDouble:(double)value forKey:(int32_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeDoubleForKey:(int32_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Int32 -> Enum |
+/** |
+ * Class used for map fields of <int32_t, int32_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBInt32EnumDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** The validation function to check if the enums are valid. */ |
@property(nonatomic, readonly) GPBEnumValidationFunc validationFunc; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given validation function. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * |
+ * @return A newly instanced dictionary. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param rawValue The raw enum value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
rawValue:(int32_t)rawValue |
forKey:(int32_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param values The raw enum values values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
rawValues:(const int32_t [])values |
forKeys:(const int32_t [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBInt32EnumDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
capacity:(NSUInteger)numItems; |
+/** |
+ * Initializes a dictionary with the given validation function. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * |
+ * @return A newly initialized dictionary. |
+ **/ |
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func; |
+ |
+/** |
+ * Initializes a dictionary with the entries given. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param values The raw enum values values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly initialized dictionary with the keys and values in it. |
+ **/ |
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func |
rawValues:(const int32_t [])values |
forKeys:(const int32_t [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
- (instancetype)initWithDictionary:(GPBInt32EnumDictionary *)dictionary; |
+ |
+/** |
+ * Initializes a dictionary with the given capacity. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly initialized dictionary with the given capacity. |
+ **/ |
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func |
capacity:(NSUInteger)numItems; |
@@ -666,19 +2560,63 @@ NS_ASSUME_NONNULL_BEGIN |
// is not a valid enumerator as defined by validationFunc. If the actual value is |
// desired, use "raw" version of the method. |
-- (BOOL)valueForKey:(int32_t)key value:(nullable int32_t *)value; |
- |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getEnum:(nullable int32_t *)value forKey:(int32_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndEnumsUsingBlock: |
(void (^)(int32_t key, int32_t value, BOOL *stop))block; |
-// These methods bypass the validationFunc to provide access to values that were not |
-// known at the time the binary was compiled. |
- |
-- (BOOL)valueForKey:(int32_t)key rawValue:(nullable int32_t *)rawValue; |
- |
+/** |
+ * Gets the raw enum value for the given key. |
+ * |
+ * @note This method bypass the validationFunc to enable the access of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param rawValue Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getRawValue:(nullable int32_t *)rawValue forKey:(int32_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @note This method bypass the validationFunc to enable the access of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **rawValue**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
- (void)enumerateKeysAndRawValuesUsingBlock: |
(void (^)(int32_t key, int32_t rawValue, BOOL *stop))block; |
+/** |
+ * Adds the keys and raw enum values from another dictionary. |
+ * |
+ * @note This method bypass the validationFunc to enable the setting of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addRawEntriesFromDictionary:(GPBInt32EnumDictionary *)otherDictionary; |
// If value is not a valid enumerator as defined by validationFunc, these |
@@ -686,325 +2624,1312 @@ NS_ASSUME_NONNULL_BEGIN |
// to the default value. Use the rawValue methods below to assign non enumerator |
// values. |
-- (void)setValue:(int32_t)value forKey:(int32_t)key; |
- |
-// This method bypass the validationFunc to provide setting of values that were not |
-// known at the time the binary was compiled. |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setEnum:(int32_t)value forKey:(int32_t)key; |
+ |
+/** |
+ * Sets the raw enum value for the given key. |
+ * |
+ * @note This method bypass the validationFunc to enable the setting of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param rawValue The raw enum value to set. |
+ * @param key The key under which to store the raw enum value. |
+ **/ |
- (void)setRawValue:(int32_t)rawValue forKey:(int32_t)key; |
-// No validation applies to these methods. |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeEnumForKey:(int32_t)aKey; |
-- (void)removeValueForKey:(int32_t)aKey; |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Int32 -> Object |
+/** |
+ * Class used for map fields of <int32_t, ObjectType> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBInt32ObjectDictionary<__covariant ObjectType> : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param object The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
+ (instancetype)dictionaryWithObject:(ObjectType)object |
forKey:(int32_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param objects The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
+ (instancetype)dictionaryWithObjects:(const ObjectType GPB_UNSAFE_UNRETAINED [])objects |
forKeys:(const int32_t [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBInt32ObjectDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param objects The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
- (instancetype)initWithObjects:(const ObjectType GPB_UNSAFE_UNRETAINED [])objects |
forKeys:(const int32_t [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBInt32ObjectDictionary *)dictionary; |
+ |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
- (instancetype)initWithCapacity:(NSUInteger)numItems; |
+/** |
+ * Fetches the object stored under the given key. |
+ * |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return The object if found, nil otherwise. |
+ **/ |
- (ObjectType)objectForKey:(int32_t)key; |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **object**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
- (void)enumerateKeysAndObjectsUsingBlock: |
(void (^)(int32_t key, ObjectType object, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBInt32ObjectDictionary *)otherDictionary; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param object The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
- (void)setObject:(ObjectType)object forKey:(int32_t)key; |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
- (void)removeObjectForKey:(int32_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - UInt64 -> UInt32 |
+/** |
+ * Class used for map fields of <uint64_t, uint32_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBUInt64UInt32Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(uint32_t)value |
- forKey:(uint64_t)key; |
-+ (instancetype)dictionaryWithValues:(const uint32_t [])values |
- forKeys:(const uint64_t [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt32:(uint32_t)value |
+ forKey:(uint64_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt32s:(const uint32_t [])values |
+ forKeys:(const uint64_t [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBUInt64UInt32Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const uint32_t [])values |
- forKeys:(const uint64_t [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithUInt32s:(const uint32_t [])values |
+ forKeys:(const uint64_t [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBUInt64UInt32Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(uint64_t)key value:(nullable uint32_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getUInt32:(nullable uint32_t *)value forKey:(uint64_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndUInt32sUsingBlock: |
(void (^)(uint64_t key, uint32_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBUInt64UInt32Dictionary *)otherDictionary; |
-- (void)setValue:(uint32_t)value forKey:(uint64_t)key; |
- |
-- (void)removeValueForKey:(uint64_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setUInt32:(uint32_t)value forKey:(uint64_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeUInt32ForKey:(uint64_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - UInt64 -> Int32 |
+/** |
+ * Class used for map fields of <uint64_t, int32_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBUInt64Int32Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(int32_t)value |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithInt32:(int32_t)value |
forKey:(uint64_t)key; |
-+ (instancetype)dictionaryWithValues:(const int32_t [])values |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithInt32s:(const int32_t [])values |
forKeys:(const uint64_t [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBUInt64Int32Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const int32_t [])values |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithInt32s:(const int32_t [])values |
forKeys:(const uint64_t [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBUInt64Int32Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(uint64_t)key value:(nullable int32_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getInt32:(nullable int32_t *)value forKey:(uint64_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndInt32sUsingBlock: |
(void (^)(uint64_t key, int32_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBUInt64Int32Dictionary *)otherDictionary; |
-- (void)setValue:(int32_t)value forKey:(uint64_t)key; |
- |
-- (void)removeValueForKey:(uint64_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setInt32:(int32_t)value forKey:(uint64_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeInt32ForKey:(uint64_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - UInt64 -> UInt64 |
+/** |
+ * Class used for map fields of <uint64_t, uint64_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBUInt64UInt64Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(uint64_t)value |
- forKey:(uint64_t)key; |
-+ (instancetype)dictionaryWithValues:(const uint64_t [])values |
- forKeys:(const uint64_t [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt64:(uint64_t)value |
+ forKey:(uint64_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt64s:(const uint64_t [])values |
+ forKeys:(const uint64_t [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBUInt64UInt64Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const uint64_t [])values |
- forKeys:(const uint64_t [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithUInt64s:(const uint64_t [])values |
+ forKeys:(const uint64_t [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBUInt64UInt64Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(uint64_t)key value:(nullable uint64_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getUInt64:(nullable uint64_t *)value forKey:(uint64_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndUInt64sUsingBlock: |
(void (^)(uint64_t key, uint64_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBUInt64UInt64Dictionary *)otherDictionary; |
-- (void)setValue:(uint64_t)value forKey:(uint64_t)key; |
- |
-- (void)removeValueForKey:(uint64_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setUInt64:(uint64_t)value forKey:(uint64_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeUInt64ForKey:(uint64_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - UInt64 -> Int64 |
+/** |
+ * Class used for map fields of <uint64_t, int64_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBUInt64Int64Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(int64_t)value |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithInt64:(int64_t)value |
forKey:(uint64_t)key; |
-+ (instancetype)dictionaryWithValues:(const int64_t [])values |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithInt64s:(const int64_t [])values |
forKeys:(const uint64_t [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBUInt64Int64Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const int64_t [])values |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithInt64s:(const int64_t [])values |
forKeys:(const uint64_t [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBUInt64Int64Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(uint64_t)key value:(nullable int64_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getInt64:(nullable int64_t *)value forKey:(uint64_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndInt64sUsingBlock: |
(void (^)(uint64_t key, int64_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBUInt64Int64Dictionary *)otherDictionary; |
-- (void)setValue:(int64_t)value forKey:(uint64_t)key; |
- |
-- (void)removeValueForKey:(uint64_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setInt64:(int64_t)value forKey:(uint64_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeInt64ForKey:(uint64_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - UInt64 -> Bool |
+/** |
+ * Class used for map fields of <uint64_t, BOOL> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBUInt64BoolDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(BOOL)value |
- forKey:(uint64_t)key; |
-+ (instancetype)dictionaryWithValues:(const BOOL [])values |
- forKeys:(const uint64_t [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithBool:(BOOL)value |
+ forKey:(uint64_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithBools:(const BOOL [])values |
+ forKeys:(const uint64_t [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBUInt64BoolDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const BOOL [])values |
- forKeys:(const uint64_t [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithBools:(const BOOL [])values |
+ forKeys:(const uint64_t [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBUInt64BoolDictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(uint64_t)key value:(nullable BOOL *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getBool:(nullable BOOL *)value forKey:(uint64_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndBoolsUsingBlock: |
(void (^)(uint64_t key, BOOL value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBUInt64BoolDictionary *)otherDictionary; |
-- (void)setValue:(BOOL)value forKey:(uint64_t)key; |
- |
-- (void)removeValueForKey:(uint64_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setBool:(BOOL)value forKey:(uint64_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeBoolForKey:(uint64_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - UInt64 -> Float |
+/** |
+ * Class used for map fields of <uint64_t, float> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBUInt64FloatDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(float)value |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithFloat:(float)value |
forKey:(uint64_t)key; |
-+ (instancetype)dictionaryWithValues:(const float [])values |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithFloats:(const float [])values |
forKeys:(const uint64_t [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBUInt64FloatDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const float [])values |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithFloats:(const float [])values |
forKeys:(const uint64_t [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBUInt64FloatDictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(uint64_t)key value:(nullable float *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getFloat:(nullable float *)value forKey:(uint64_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndFloatsUsingBlock: |
(void (^)(uint64_t key, float value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBUInt64FloatDictionary *)otherDictionary; |
-- (void)setValue:(float)value forKey:(uint64_t)key; |
- |
-- (void)removeValueForKey:(uint64_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setFloat:(float)value forKey:(uint64_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeFloatForKey:(uint64_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - UInt64 -> Double |
+/** |
+ * Class used for map fields of <uint64_t, double> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBUInt64DoubleDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(double)value |
- forKey:(uint64_t)key; |
-+ (instancetype)dictionaryWithValues:(const double [])values |
- forKeys:(const uint64_t [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithDouble:(double)value |
+ forKey:(uint64_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithDoubles:(const double [])values |
+ forKeys:(const uint64_t [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBUInt64DoubleDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const double [])values |
- forKeys:(const uint64_t [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithDoubles:(const double [])values |
+ forKeys:(const uint64_t [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBUInt64DoubleDictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(uint64_t)key value:(nullable double *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getDouble:(nullable double *)value forKey:(uint64_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndDoublesUsingBlock: |
(void (^)(uint64_t key, double value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBUInt64DoubleDictionary *)otherDictionary; |
-- (void)setValue:(double)value forKey:(uint64_t)key; |
- |
-- (void)removeValueForKey:(uint64_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setDouble:(double)value forKey:(uint64_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeDoubleForKey:(uint64_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - UInt64 -> Enum |
+/** |
+ * Class used for map fields of <uint64_t, int32_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBUInt64EnumDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** The validation function to check if the enums are valid. */ |
@property(nonatomic, readonly) GPBEnumValidationFunc validationFunc; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given validation function. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * |
+ * @return A newly instanced dictionary. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param rawValue The raw enum value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
rawValue:(int32_t)rawValue |
forKey:(uint64_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param values The raw enum values values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
rawValues:(const int32_t [])values |
forKeys:(const uint64_t [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBUInt64EnumDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
capacity:(NSUInteger)numItems; |
+/** |
+ * Initializes a dictionary with the given validation function. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * |
+ * @return A newly initialized dictionary. |
+ **/ |
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func; |
+ |
+/** |
+ * Initializes a dictionary with the entries given. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param values The raw enum values values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly initialized dictionary with the keys and values in it. |
+ **/ |
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func |
rawValues:(const int32_t [])values |
forKeys:(const uint64_t [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
- (instancetype)initWithDictionary:(GPBUInt64EnumDictionary *)dictionary; |
+ |
+/** |
+ * Initializes a dictionary with the given capacity. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly initialized dictionary with the given capacity. |
+ **/ |
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func |
capacity:(NSUInteger)numItems; |
@@ -1012,19 +3937,63 @@ NS_ASSUME_NONNULL_BEGIN |
// is not a valid enumerator as defined by validationFunc. If the actual value is |
// desired, use "raw" version of the method. |
-- (BOOL)valueForKey:(uint64_t)key value:(nullable int32_t *)value; |
- |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getEnum:(nullable int32_t *)value forKey:(uint64_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndEnumsUsingBlock: |
(void (^)(uint64_t key, int32_t value, BOOL *stop))block; |
-// These methods bypass the validationFunc to provide access to values that were not |
-// known at the time the binary was compiled. |
- |
-- (BOOL)valueForKey:(uint64_t)key rawValue:(nullable int32_t *)rawValue; |
- |
+/** |
+ * Gets the raw enum value for the given key. |
+ * |
+ * @note This method bypass the validationFunc to enable the access of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param rawValue Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getRawValue:(nullable int32_t *)rawValue forKey:(uint64_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @note This method bypass the validationFunc to enable the access of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **rawValue**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
- (void)enumerateKeysAndRawValuesUsingBlock: |
(void (^)(uint64_t key, int32_t rawValue, BOOL *stop))block; |
+/** |
+ * Adds the keys and raw enum values from another dictionary. |
+ * |
+ * @note This method bypass the validationFunc to enable the setting of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addRawEntriesFromDictionary:(GPBUInt64EnumDictionary *)otherDictionary; |
// If value is not a valid enumerator as defined by validationFunc, these |
@@ -1032,325 +4001,1312 @@ NS_ASSUME_NONNULL_BEGIN |
// to the default value. Use the rawValue methods below to assign non enumerator |
// values. |
-- (void)setValue:(int32_t)value forKey:(uint64_t)key; |
- |
-// This method bypass the validationFunc to provide setting of values that were not |
-// known at the time the binary was compiled. |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setEnum:(int32_t)value forKey:(uint64_t)key; |
+ |
+/** |
+ * Sets the raw enum value for the given key. |
+ * |
+ * @note This method bypass the validationFunc to enable the setting of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param rawValue The raw enum value to set. |
+ * @param key The key under which to store the raw enum value. |
+ **/ |
- (void)setRawValue:(int32_t)rawValue forKey:(uint64_t)key; |
-// No validation applies to these methods. |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeEnumForKey:(uint64_t)aKey; |
-- (void)removeValueForKey:(uint64_t)aKey; |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - UInt64 -> Object |
+/** |
+ * Class used for map fields of <uint64_t, ObjectType> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBUInt64ObjectDictionary<__covariant ObjectType> : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param object The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
+ (instancetype)dictionaryWithObject:(ObjectType)object |
forKey:(uint64_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param objects The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
+ (instancetype)dictionaryWithObjects:(const ObjectType GPB_UNSAFE_UNRETAINED [])objects |
forKeys:(const uint64_t [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBUInt64ObjectDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param objects The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
- (instancetype)initWithObjects:(const ObjectType GPB_UNSAFE_UNRETAINED [])objects |
forKeys:(const uint64_t [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBUInt64ObjectDictionary *)dictionary; |
+ |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
- (instancetype)initWithCapacity:(NSUInteger)numItems; |
+/** |
+ * Fetches the object stored under the given key. |
+ * |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return The object if found, nil otherwise. |
+ **/ |
- (ObjectType)objectForKey:(uint64_t)key; |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **object**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
- (void)enumerateKeysAndObjectsUsingBlock: |
(void (^)(uint64_t key, ObjectType object, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBUInt64ObjectDictionary *)otherDictionary; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param object The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
- (void)setObject:(ObjectType)object forKey:(uint64_t)key; |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
- (void)removeObjectForKey:(uint64_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Int64 -> UInt32 |
+/** |
+ * Class used for map fields of <int64_t, uint32_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBInt64UInt32Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(uint32_t)value |
- forKey:(int64_t)key; |
-+ (instancetype)dictionaryWithValues:(const uint32_t [])values |
- forKeys:(const int64_t [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt32:(uint32_t)value |
+ forKey:(int64_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt32s:(const uint32_t [])values |
+ forKeys:(const int64_t [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBInt64UInt32Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const uint32_t [])values |
- forKeys:(const int64_t [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithUInt32s:(const uint32_t [])values |
+ forKeys:(const int64_t [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBInt64UInt32Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(int64_t)key value:(nullable uint32_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getUInt32:(nullable uint32_t *)value forKey:(int64_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndUInt32sUsingBlock: |
(void (^)(int64_t key, uint32_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBInt64UInt32Dictionary *)otherDictionary; |
-- (void)setValue:(uint32_t)value forKey:(int64_t)key; |
- |
-- (void)removeValueForKey:(int64_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setUInt32:(uint32_t)value forKey:(int64_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeUInt32ForKey:(int64_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Int64 -> Int32 |
+/** |
+ * Class used for map fields of <int64_t, int32_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBInt64Int32Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(int32_t)value |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithInt32:(int32_t)value |
forKey:(int64_t)key; |
-+ (instancetype)dictionaryWithValues:(const int32_t [])values |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithInt32s:(const int32_t [])values |
forKeys:(const int64_t [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBInt64Int32Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const int32_t [])values |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithInt32s:(const int32_t [])values |
forKeys:(const int64_t [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBInt64Int32Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(int64_t)key value:(nullable int32_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getInt32:(nullable int32_t *)value forKey:(int64_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndInt32sUsingBlock: |
(void (^)(int64_t key, int32_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBInt64Int32Dictionary *)otherDictionary; |
-- (void)setValue:(int32_t)value forKey:(int64_t)key; |
- |
-- (void)removeValueForKey:(int64_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setInt32:(int32_t)value forKey:(int64_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeInt32ForKey:(int64_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Int64 -> UInt64 |
+/** |
+ * Class used for map fields of <int64_t, uint64_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBInt64UInt64Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(uint64_t)value |
- forKey:(int64_t)key; |
-+ (instancetype)dictionaryWithValues:(const uint64_t [])values |
- forKeys:(const int64_t [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt64:(uint64_t)value |
+ forKey:(int64_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt64s:(const uint64_t [])values |
+ forKeys:(const int64_t [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBInt64UInt64Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const uint64_t [])values |
- forKeys:(const int64_t [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithUInt64s:(const uint64_t [])values |
+ forKeys:(const int64_t [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBInt64UInt64Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(int64_t)key value:(nullable uint64_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getUInt64:(nullable uint64_t *)value forKey:(int64_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndUInt64sUsingBlock: |
(void (^)(int64_t key, uint64_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBInt64UInt64Dictionary *)otherDictionary; |
-- (void)setValue:(uint64_t)value forKey:(int64_t)key; |
- |
-- (void)removeValueForKey:(int64_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setUInt64:(uint64_t)value forKey:(int64_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeUInt64ForKey:(int64_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Int64 -> Int64 |
+/** |
+ * Class used for map fields of <int64_t, int64_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBInt64Int64Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(int64_t)value |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithInt64:(int64_t)value |
forKey:(int64_t)key; |
-+ (instancetype)dictionaryWithValues:(const int64_t [])values |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithInt64s:(const int64_t [])values |
forKeys:(const int64_t [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBInt64Int64Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const int64_t [])values |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithInt64s:(const int64_t [])values |
forKeys:(const int64_t [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBInt64Int64Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(int64_t)key value:(nullable int64_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getInt64:(nullable int64_t *)value forKey:(int64_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndInt64sUsingBlock: |
(void (^)(int64_t key, int64_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBInt64Int64Dictionary *)otherDictionary; |
-- (void)setValue:(int64_t)value forKey:(int64_t)key; |
- |
-- (void)removeValueForKey:(int64_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setInt64:(int64_t)value forKey:(int64_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeInt64ForKey:(int64_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Int64 -> Bool |
+/** |
+ * Class used for map fields of <int64_t, BOOL> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBInt64BoolDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(BOOL)value |
- forKey:(int64_t)key; |
-+ (instancetype)dictionaryWithValues:(const BOOL [])values |
- forKeys:(const int64_t [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithBool:(BOOL)value |
+ forKey:(int64_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithBools:(const BOOL [])values |
+ forKeys:(const int64_t [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBInt64BoolDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const BOOL [])values |
- forKeys:(const int64_t [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithBools:(const BOOL [])values |
+ forKeys:(const int64_t [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBInt64BoolDictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(int64_t)key value:(nullable BOOL *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getBool:(nullable BOOL *)value forKey:(int64_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndBoolsUsingBlock: |
(void (^)(int64_t key, BOOL value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBInt64BoolDictionary *)otherDictionary; |
-- (void)setValue:(BOOL)value forKey:(int64_t)key; |
- |
-- (void)removeValueForKey:(int64_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setBool:(BOOL)value forKey:(int64_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeBoolForKey:(int64_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Int64 -> Float |
+/** |
+ * Class used for map fields of <int64_t, float> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBInt64FloatDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(float)value |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithFloat:(float)value |
forKey:(int64_t)key; |
-+ (instancetype)dictionaryWithValues:(const float [])values |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithFloats:(const float [])values |
forKeys:(const int64_t [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBInt64FloatDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const float [])values |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithFloats:(const float [])values |
forKeys:(const int64_t [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBInt64FloatDictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(int64_t)key value:(nullable float *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getFloat:(nullable float *)value forKey:(int64_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndFloatsUsingBlock: |
(void (^)(int64_t key, float value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBInt64FloatDictionary *)otherDictionary; |
-- (void)setValue:(float)value forKey:(int64_t)key; |
- |
-- (void)removeValueForKey:(int64_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setFloat:(float)value forKey:(int64_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeFloatForKey:(int64_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Int64 -> Double |
+/** |
+ * Class used for map fields of <int64_t, double> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBInt64DoubleDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(double)value |
- forKey:(int64_t)key; |
-+ (instancetype)dictionaryWithValues:(const double [])values |
- forKeys:(const int64_t [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithDouble:(double)value |
+ forKey:(int64_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithDoubles:(const double [])values |
+ forKeys:(const int64_t [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBInt64DoubleDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const double [])values |
- forKeys:(const int64_t [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithDoubles:(const double [])values |
+ forKeys:(const int64_t [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBInt64DoubleDictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(int64_t)key value:(nullable double *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getDouble:(nullable double *)value forKey:(int64_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndDoublesUsingBlock: |
(void (^)(int64_t key, double value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBInt64DoubleDictionary *)otherDictionary; |
-- (void)setValue:(double)value forKey:(int64_t)key; |
- |
-- (void)removeValueForKey:(int64_t)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setDouble:(double)value forKey:(int64_t)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeDoubleForKey:(int64_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Int64 -> Enum |
+/** |
+ * Class used for map fields of <int64_t, int32_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBInt64EnumDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** The validation function to check if the enums are valid. */ |
@property(nonatomic, readonly) GPBEnumValidationFunc validationFunc; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given validation function. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * |
+ * @return A newly instanced dictionary. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param rawValue The raw enum value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
rawValue:(int32_t)rawValue |
forKey:(int64_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param values The raw enum values values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
rawValues:(const int32_t [])values |
forKeys:(const int64_t [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBInt64EnumDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
capacity:(NSUInteger)numItems; |
+/** |
+ * Initializes a dictionary with the given validation function. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * |
+ * @return A newly initialized dictionary. |
+ **/ |
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func; |
+ |
+/** |
+ * Initializes a dictionary with the entries given. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param values The raw enum values values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly initialized dictionary with the keys and values in it. |
+ **/ |
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func |
rawValues:(const int32_t [])values |
forKeys:(const int64_t [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
- (instancetype)initWithDictionary:(GPBInt64EnumDictionary *)dictionary; |
+ |
+/** |
+ * Initializes a dictionary with the given capacity. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly initialized dictionary with the given capacity. |
+ **/ |
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func |
capacity:(NSUInteger)numItems; |
@@ -1358,19 +5314,63 @@ NS_ASSUME_NONNULL_BEGIN |
// is not a valid enumerator as defined by validationFunc. If the actual value is |
// desired, use "raw" version of the method. |
-- (BOOL)valueForKey:(int64_t)key value:(nullable int32_t *)value; |
- |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getEnum:(nullable int32_t *)value forKey:(int64_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndEnumsUsingBlock: |
(void (^)(int64_t key, int32_t value, BOOL *stop))block; |
-// These methods bypass the validationFunc to provide access to values that were not |
-// known at the time the binary was compiled. |
- |
-- (BOOL)valueForKey:(int64_t)key rawValue:(nullable int32_t *)rawValue; |
- |
+/** |
+ * Gets the raw enum value for the given key. |
+ * |
+ * @note This method bypass the validationFunc to enable the access of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param rawValue Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getRawValue:(nullable int32_t *)rawValue forKey:(int64_t)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @note This method bypass the validationFunc to enable the access of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **rawValue**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
- (void)enumerateKeysAndRawValuesUsingBlock: |
(void (^)(int64_t key, int32_t rawValue, BOOL *stop))block; |
+/** |
+ * Adds the keys and raw enum values from another dictionary. |
+ * |
+ * @note This method bypass the validationFunc to enable the setting of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addRawEntriesFromDictionary:(GPBInt64EnumDictionary *)otherDictionary; |
// If value is not a valid enumerator as defined by validationFunc, these |
@@ -1378,325 +5378,1312 @@ NS_ASSUME_NONNULL_BEGIN |
// to the default value. Use the rawValue methods below to assign non enumerator |
// values. |
-- (void)setValue:(int32_t)value forKey:(int64_t)key; |
- |
-// This method bypass the validationFunc to provide setting of values that were not |
-// known at the time the binary was compiled. |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setEnum:(int32_t)value forKey:(int64_t)key; |
+ |
+/** |
+ * Sets the raw enum value for the given key. |
+ * |
+ * @note This method bypass the validationFunc to enable the setting of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param rawValue The raw enum value to set. |
+ * @param key The key under which to store the raw enum value. |
+ **/ |
- (void)setRawValue:(int32_t)rawValue forKey:(int64_t)key; |
-// No validation applies to these methods. |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeEnumForKey:(int64_t)aKey; |
-- (void)removeValueForKey:(int64_t)aKey; |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Int64 -> Object |
+/** |
+ * Class used for map fields of <int64_t, ObjectType> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBInt64ObjectDictionary<__covariant ObjectType> : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param object The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
+ (instancetype)dictionaryWithObject:(ObjectType)object |
forKey:(int64_t)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param objects The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
+ (instancetype)dictionaryWithObjects:(const ObjectType GPB_UNSAFE_UNRETAINED [])objects |
forKeys:(const int64_t [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBInt64ObjectDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param objects The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
- (instancetype)initWithObjects:(const ObjectType GPB_UNSAFE_UNRETAINED [])objects |
forKeys:(const int64_t [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBInt64ObjectDictionary *)dictionary; |
+ |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
- (instancetype)initWithCapacity:(NSUInteger)numItems; |
+/** |
+ * Fetches the object stored under the given key. |
+ * |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return The object if found, nil otherwise. |
+ **/ |
- (ObjectType)objectForKey:(int64_t)key; |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **object**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
- (void)enumerateKeysAndObjectsUsingBlock: |
(void (^)(int64_t key, ObjectType object, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBInt64ObjectDictionary *)otherDictionary; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param object The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
- (void)setObject:(ObjectType)object forKey:(int64_t)key; |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
- (void)removeObjectForKey:(int64_t)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Bool -> UInt32 |
+/** |
+ * Class used for map fields of <BOOL, uint32_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBBoolUInt32Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(uint32_t)value |
- forKey:(BOOL)key; |
-+ (instancetype)dictionaryWithValues:(const uint32_t [])values |
- forKeys:(const BOOL [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt32:(uint32_t)value |
+ forKey:(BOOL)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt32s:(const uint32_t [])values |
+ forKeys:(const BOOL [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBBoolUInt32Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const uint32_t [])values |
- forKeys:(const BOOL [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithUInt32s:(const uint32_t [])values |
+ forKeys:(const BOOL [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBBoolUInt32Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(BOOL)key value:(nullable uint32_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getUInt32:(nullable uint32_t *)value forKey:(BOOL)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndUInt32sUsingBlock: |
(void (^)(BOOL key, uint32_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBBoolUInt32Dictionary *)otherDictionary; |
-- (void)setValue:(uint32_t)value forKey:(BOOL)key; |
- |
-- (void)removeValueForKey:(BOOL)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setUInt32:(uint32_t)value forKey:(BOOL)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeUInt32ForKey:(BOOL)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Bool -> Int32 |
+/** |
+ * Class used for map fields of <BOOL, int32_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBBoolInt32Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(int32_t)value |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithInt32:(int32_t)value |
forKey:(BOOL)key; |
-+ (instancetype)dictionaryWithValues:(const int32_t [])values |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithInt32s:(const int32_t [])values |
forKeys:(const BOOL [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBBoolInt32Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const int32_t [])values |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithInt32s:(const int32_t [])values |
forKeys:(const BOOL [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBBoolInt32Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(BOOL)key value:(nullable int32_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getInt32:(nullable int32_t *)value forKey:(BOOL)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndInt32sUsingBlock: |
(void (^)(BOOL key, int32_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBBoolInt32Dictionary *)otherDictionary; |
-- (void)setValue:(int32_t)value forKey:(BOOL)key; |
- |
-- (void)removeValueForKey:(BOOL)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setInt32:(int32_t)value forKey:(BOOL)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeInt32ForKey:(BOOL)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Bool -> UInt64 |
+/** |
+ * Class used for map fields of <BOOL, uint64_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBBoolUInt64Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(uint64_t)value |
- forKey:(BOOL)key; |
-+ (instancetype)dictionaryWithValues:(const uint64_t [])values |
- forKeys:(const BOOL [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt64:(uint64_t)value |
+ forKey:(BOOL)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt64s:(const uint64_t [])values |
+ forKeys:(const BOOL [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBBoolUInt64Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const uint64_t [])values |
- forKeys:(const BOOL [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithUInt64s:(const uint64_t [])values |
+ forKeys:(const BOOL [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBBoolUInt64Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(BOOL)key value:(nullable uint64_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getUInt64:(nullable uint64_t *)value forKey:(BOOL)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndUInt64sUsingBlock: |
(void (^)(BOOL key, uint64_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBBoolUInt64Dictionary *)otherDictionary; |
-- (void)setValue:(uint64_t)value forKey:(BOOL)key; |
- |
-- (void)removeValueForKey:(BOOL)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setUInt64:(uint64_t)value forKey:(BOOL)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeUInt64ForKey:(BOOL)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Bool -> Int64 |
+/** |
+ * Class used for map fields of <BOOL, int64_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBBoolInt64Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(int64_t)value |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithInt64:(int64_t)value |
forKey:(BOOL)key; |
-+ (instancetype)dictionaryWithValues:(const int64_t [])values |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithInt64s:(const int64_t [])values |
forKeys:(const BOOL [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBBoolInt64Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const int64_t [])values |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithInt64s:(const int64_t [])values |
forKeys:(const BOOL [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBBoolInt64Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(BOOL)key value:(nullable int64_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getInt64:(nullable int64_t *)value forKey:(BOOL)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndInt64sUsingBlock: |
(void (^)(BOOL key, int64_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBBoolInt64Dictionary *)otherDictionary; |
-- (void)setValue:(int64_t)value forKey:(BOOL)key; |
- |
-- (void)removeValueForKey:(BOOL)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setInt64:(int64_t)value forKey:(BOOL)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeInt64ForKey:(BOOL)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Bool -> Bool |
+/** |
+ * Class used for map fields of <BOOL, BOOL> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBBoolBoolDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(BOOL)value |
- forKey:(BOOL)key; |
-+ (instancetype)dictionaryWithValues:(const BOOL [])values |
- forKeys:(const BOOL [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithBool:(BOOL)value |
+ forKey:(BOOL)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithBools:(const BOOL [])values |
+ forKeys:(const BOOL [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBBoolBoolDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const BOOL [])values |
- forKeys:(const BOOL [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithBools:(const BOOL [])values |
+ forKeys:(const BOOL [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBBoolBoolDictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(BOOL)key value:(nullable BOOL *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getBool:(nullable BOOL *)value forKey:(BOOL)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndBoolsUsingBlock: |
(void (^)(BOOL key, BOOL value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBBoolBoolDictionary *)otherDictionary; |
-- (void)setValue:(BOOL)value forKey:(BOOL)key; |
- |
-- (void)removeValueForKey:(BOOL)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setBool:(BOOL)value forKey:(BOOL)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeBoolForKey:(BOOL)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Bool -> Float |
+/** |
+ * Class used for map fields of <BOOL, float> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBBoolFloatDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(float)value |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithFloat:(float)value |
forKey:(BOOL)key; |
-+ (instancetype)dictionaryWithValues:(const float [])values |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithFloats:(const float [])values |
forKeys:(const BOOL [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBBoolFloatDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const float [])values |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithFloats:(const float [])values |
forKeys:(const BOOL [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBBoolFloatDictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(BOOL)key value:(nullable float *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getFloat:(nullable float *)value forKey:(BOOL)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndFloatsUsingBlock: |
(void (^)(BOOL key, float value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBBoolFloatDictionary *)otherDictionary; |
-- (void)setValue:(float)value forKey:(BOOL)key; |
- |
-- (void)removeValueForKey:(BOOL)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setFloat:(float)value forKey:(BOOL)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeFloatForKey:(BOOL)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Bool -> Double |
+/** |
+ * Class used for map fields of <BOOL, double> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBBoolDoubleDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(double)value |
- forKey:(BOOL)key; |
-+ (instancetype)dictionaryWithValues:(const double [])values |
- forKeys:(const BOOL [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithDouble:(double)value |
+ forKey:(BOOL)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithDoubles:(const double [])values |
+ forKeys:(const BOOL [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBBoolDoubleDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const double [])values |
- forKeys:(const BOOL [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithDoubles:(const double [])values |
+ forKeys:(const BOOL [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBBoolDoubleDictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(BOOL)key value:(nullable double *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getDouble:(nullable double *)value forKey:(BOOL)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndDoublesUsingBlock: |
(void (^)(BOOL key, double value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBBoolDoubleDictionary *)otherDictionary; |
-- (void)setValue:(double)value forKey:(BOOL)key; |
- |
-- (void)removeValueForKey:(BOOL)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setDouble:(double)value forKey:(BOOL)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeDoubleForKey:(BOOL)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Bool -> Enum |
+/** |
+ * Class used for map fields of <BOOL, int32_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBBoolEnumDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** The validation function to check if the enums are valid. */ |
@property(nonatomic, readonly) GPBEnumValidationFunc validationFunc; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given validation function. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * |
+ * @return A newly instanced dictionary. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param rawValue The raw enum value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
rawValue:(int32_t)rawValue |
forKey:(BOOL)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param values The raw enum values values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
rawValues:(const int32_t [])values |
forKeys:(const BOOL [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBBoolEnumDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
capacity:(NSUInteger)numItems; |
+/** |
+ * Initializes a dictionary with the given validation function. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * |
+ * @return A newly initialized dictionary. |
+ **/ |
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func; |
+ |
+/** |
+ * Initializes a dictionary with the entries given. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param values The raw enum values values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly initialized dictionary with the keys and values in it. |
+ **/ |
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func |
rawValues:(const int32_t [])values |
forKeys:(const BOOL [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
- (instancetype)initWithDictionary:(GPBBoolEnumDictionary *)dictionary; |
+ |
+/** |
+ * Initializes a dictionary with the given capacity. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly initialized dictionary with the given capacity. |
+ **/ |
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func |
capacity:(NSUInteger)numItems; |
@@ -1704,19 +6691,63 @@ NS_ASSUME_NONNULL_BEGIN |
// is not a valid enumerator as defined by validationFunc. If the actual value is |
// desired, use "raw" version of the method. |
-- (BOOL)valueForKey:(BOOL)key value:(nullable int32_t *)value; |
- |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getEnum:(nullable int32_t *)value forKey:(BOOL)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndEnumsUsingBlock: |
(void (^)(BOOL key, int32_t value, BOOL *stop))block; |
-// These methods bypass the validationFunc to provide access to values that were not |
-// known at the time the binary was compiled. |
- |
-- (BOOL)valueForKey:(BOOL)key rawValue:(nullable int32_t *)rawValue; |
- |
+/** |
+ * Gets the raw enum value for the given key. |
+ * |
+ * @note This method bypass the validationFunc to enable the access of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param rawValue Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getRawValue:(nullable int32_t *)rawValue forKey:(BOOL)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @note This method bypass the validationFunc to enable the access of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **rawValue**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
- (void)enumerateKeysAndRawValuesUsingBlock: |
(void (^)(BOOL key, int32_t rawValue, BOOL *stop))block; |
+/** |
+ * Adds the keys and raw enum values from another dictionary. |
+ * |
+ * @note This method bypass the validationFunc to enable the setting of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addRawEntriesFromDictionary:(GPBBoolEnumDictionary *)otherDictionary; |
// If value is not a valid enumerator as defined by validationFunc, these |
@@ -1724,325 +6755,1312 @@ NS_ASSUME_NONNULL_BEGIN |
// to the default value. Use the rawValue methods below to assign non enumerator |
// values. |
-- (void)setValue:(int32_t)value forKey:(BOOL)key; |
- |
-// This method bypass the validationFunc to provide setting of values that were not |
-// known at the time the binary was compiled. |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setEnum:(int32_t)value forKey:(BOOL)key; |
+ |
+/** |
+ * Sets the raw enum value for the given key. |
+ * |
+ * @note This method bypass the validationFunc to enable the setting of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param rawValue The raw enum value to set. |
+ * @param key The key under which to store the raw enum value. |
+ **/ |
- (void)setRawValue:(int32_t)rawValue forKey:(BOOL)key; |
-// No validation applies to these methods. |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeEnumForKey:(BOOL)aKey; |
-- (void)removeValueForKey:(BOOL)aKey; |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - Bool -> Object |
+/** |
+ * Class used for map fields of <BOOL, ObjectType> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBBoolObjectDictionary<__covariant ObjectType> : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param object The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
+ (instancetype)dictionaryWithObject:(ObjectType)object |
forKey:(BOOL)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param objects The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
+ (instancetype)dictionaryWithObjects:(const ObjectType GPB_UNSAFE_UNRETAINED [])objects |
forKeys:(const BOOL [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBBoolObjectDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param objects The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
- (instancetype)initWithObjects:(const ObjectType GPB_UNSAFE_UNRETAINED [])objects |
forKeys:(const BOOL [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBBoolObjectDictionary *)dictionary; |
+ |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
- (instancetype)initWithCapacity:(NSUInteger)numItems; |
+/** |
+ * Fetches the object stored under the given key. |
+ * |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return The object if found, nil otherwise. |
+ **/ |
- (ObjectType)objectForKey:(BOOL)key; |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **object**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
- (void)enumerateKeysAndObjectsUsingBlock: |
(void (^)(BOOL key, ObjectType object, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBBoolObjectDictionary *)otherDictionary; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param object The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
- (void)setObject:(ObjectType)object forKey:(BOOL)key; |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
- (void)removeObjectForKey:(BOOL)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - String -> UInt32 |
+/** |
+ * Class used for map fields of <NSString, uint32_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBStringUInt32Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(uint32_t)value |
- forKey:(NSString *)key; |
-+ (instancetype)dictionaryWithValues:(const uint32_t [])values |
- forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt32:(uint32_t)value |
+ forKey:(NSString *)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt32s:(const uint32_t [])values |
+ forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBStringUInt32Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const uint32_t [])values |
- forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithUInt32s:(const uint32_t [])values |
+ forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBStringUInt32Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(NSString *)key value:(nullable uint32_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getUInt32:(nullable uint32_t *)value forKey:(NSString *)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndUInt32sUsingBlock: |
(void (^)(NSString *key, uint32_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBStringUInt32Dictionary *)otherDictionary; |
-- (void)setValue:(uint32_t)value forKey:(NSString *)key; |
- |
-- (void)removeValueForKey:(NSString *)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setUInt32:(uint32_t)value forKey:(NSString *)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeUInt32ForKey:(NSString *)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - String -> Int32 |
+/** |
+ * Class used for map fields of <NSString, int32_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBStringInt32Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(int32_t)value |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithInt32:(int32_t)value |
forKey:(NSString *)key; |
-+ (instancetype)dictionaryWithValues:(const int32_t [])values |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithInt32s:(const int32_t [])values |
forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBStringInt32Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const int32_t [])values |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithInt32s:(const int32_t [])values |
forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBStringInt32Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(NSString *)key value:(nullable int32_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getInt32:(nullable int32_t *)value forKey:(NSString *)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndInt32sUsingBlock: |
(void (^)(NSString *key, int32_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBStringInt32Dictionary *)otherDictionary; |
-- (void)setValue:(int32_t)value forKey:(NSString *)key; |
- |
-- (void)removeValueForKey:(NSString *)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setInt32:(int32_t)value forKey:(NSString *)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeInt32ForKey:(NSString *)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - String -> UInt64 |
+/** |
+ * Class used for map fields of <NSString, uint64_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBStringUInt64Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(uint64_t)value |
- forKey:(NSString *)key; |
-+ (instancetype)dictionaryWithValues:(const uint64_t [])values |
- forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt64:(uint64_t)value |
+ forKey:(NSString *)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithUInt64s:(const uint64_t [])values |
+ forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBStringUInt64Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const uint64_t [])values |
- forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithUInt64s:(const uint64_t [])values |
+ forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBStringUInt64Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(NSString *)key value:(nullable uint64_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getUInt64:(nullable uint64_t *)value forKey:(NSString *)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndUInt64sUsingBlock: |
(void (^)(NSString *key, uint64_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBStringUInt64Dictionary *)otherDictionary; |
-- (void)setValue:(uint64_t)value forKey:(NSString *)key; |
- |
-- (void)removeValueForKey:(NSString *)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setUInt64:(uint64_t)value forKey:(NSString *)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeUInt64ForKey:(NSString *)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - String -> Int64 |
+/** |
+ * Class used for map fields of <NSString, int64_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBStringInt64Dictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(int64_t)value |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithInt64:(int64_t)value |
forKey:(NSString *)key; |
-+ (instancetype)dictionaryWithValues:(const int64_t [])values |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithInt64s:(const int64_t [])values |
forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBStringInt64Dictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const int64_t [])values |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithInt64s:(const int64_t [])values |
forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBStringInt64Dictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(NSString *)key value:(nullable int64_t *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getInt64:(nullable int64_t *)value forKey:(NSString *)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndInt64sUsingBlock: |
(void (^)(NSString *key, int64_t value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBStringInt64Dictionary *)otherDictionary; |
-- (void)setValue:(int64_t)value forKey:(NSString *)key; |
- |
-- (void)removeValueForKey:(NSString *)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setInt64:(int64_t)value forKey:(NSString *)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeInt64ForKey:(NSString *)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - String -> Bool |
+/** |
+ * Class used for map fields of <NSString, BOOL> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBStringBoolDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(BOOL)value |
- forKey:(NSString *)key; |
-+ (instancetype)dictionaryWithValues:(const BOOL [])values |
- forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithBool:(BOOL)value |
+ forKey:(NSString *)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithBools:(const BOOL [])values |
+ forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBStringBoolDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const BOOL [])values |
- forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithBools:(const BOOL [])values |
+ forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBStringBoolDictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(NSString *)key value:(nullable BOOL *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getBool:(nullable BOOL *)value forKey:(NSString *)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndBoolsUsingBlock: |
(void (^)(NSString *key, BOOL value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBStringBoolDictionary *)otherDictionary; |
-- (void)setValue:(BOOL)value forKey:(NSString *)key; |
- |
-- (void)removeValueForKey:(NSString *)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setBool:(BOOL)value forKey:(NSString *)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeBoolForKey:(NSString *)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - String -> Float |
+/** |
+ * Class used for map fields of <NSString, float> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBStringFloatDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(float)value |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithFloat:(float)value |
forKey:(NSString *)key; |
-+ (instancetype)dictionaryWithValues:(const float [])values |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithFloats:(const float [])values |
forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBStringFloatDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const float [])values |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithFloats:(const float [])values |
forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBStringFloatDictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(NSString *)key value:(nullable float *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getFloat:(nullable float *)value forKey:(NSString *)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndFloatsUsingBlock: |
(void (^)(NSString *key, float value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBStringFloatDictionary *)otherDictionary; |
-- (void)setValue:(float)value forKey:(NSString *)key; |
- |
-- (void)removeValueForKey:(NSString *)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setFloat:(float)value forKey:(NSString *)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeFloatForKey:(NSString *)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - String -> Double |
+/** |
+ * Class used for map fields of <NSString, double> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBStringDoubleDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
-+ (instancetype)dictionaryWithValue:(double)value |
- forKey:(NSString *)key; |
-+ (instancetype)dictionaryWithValues:(const double [])values |
- forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
- count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param value The value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
++ (instancetype)dictionaryWithDouble:(double)value |
+ forKey:(NSString *)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param values The values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
++ (instancetype)dictionaryWithDoubles:(const double [])values |
+ forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
+ count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBStringDoubleDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
-- (instancetype)initWithValues:(const double [])values |
- forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
- count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+/** |
+ * Initializes this dictionary, copying the given values and keys. |
+ * |
+ * @param values The values to be placed in this dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of elements to copy into the dictionary. |
+ * |
+ * @return A newly initialized dictionary with a copy of the values and keys. |
+ **/ |
+- (instancetype)initWithDoubles:(const double [])values |
+ forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
+ count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes this dictionary, copying the entries from the given dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries of the given dictionary. |
+ **/ |
- (instancetype)initWithDictionary:(GPBStringDoubleDictionary *)dictionary; |
-- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (BOOL)valueForKey:(NSString *)key value:(nullable double *)value; |
+/** |
+ * Initializes this dictionary with the requested capacity. |
+ * |
+ * @param numItems Number of items needed for this dictionary. |
+ * |
+ * @return A newly initialized dictionary with the requested capacity. |
+ **/ |
+- (instancetype)initWithCapacity:(NSUInteger)numItems; |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getDouble:(nullable double *)value forKey:(NSString *)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndDoublesUsingBlock: |
(void (^)(NSString *key, double value, BOOL *stop))block; |
+/** |
+ * Adds the keys and values from another dictionary. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addEntriesFromDictionary:(GPBStringDoubleDictionary *)otherDictionary; |
-- (void)setValue:(double)value forKey:(NSString *)key; |
- |
-- (void)removeValueForKey:(NSString *)aKey; |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setDouble:(double)value forKey:(NSString *)key; |
+ |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeDoubleForKey:(NSString *)aKey; |
+ |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
#pragma mark - String -> Enum |
+/** |
+ * Class used for map fields of <NSString, int32_t> |
+ * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+ * |
+ * @note This class is not meant to be subclassed. |
+ **/ |
@interface GPBStringEnumDictionary : NSObject <NSCopying> |
+/** Number of entries stored in this dictionary. */ |
@property(nonatomic, readonly) NSUInteger count; |
+/** The validation function to check if the enums are valid. */ |
@property(nonatomic, readonly) GPBEnumValidationFunc validationFunc; |
+/** |
+ * @return A newly instanced and empty dictionary. |
+ **/ |
+ (instancetype)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given validation function. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * |
+ * @return A newly instanced dictionary. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func; |
+ |
+/** |
+ * Creates and initializes a dictionary with the single entry given. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param rawValue The raw enum value to be placed in the dictionary. |
+ * @param key The key under which to store the value. |
+ * |
+ * @return A newly instanced dictionary with the key and value in it. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
rawValue:(int32_t)rawValue |
forKey:(NSString *)key; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries given. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param values The raw enum values values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the keys and values in it. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
rawValues:(const int32_t [])values |
forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
count:(NSUInteger)count; |
+ |
+/** |
+ * Creates and initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
+ (instancetype)dictionaryWithDictionary:(GPBStringEnumDictionary *)dictionary; |
+ |
+/** |
+ * Creates and initializes a dictionary with the given capacity. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly instanced dictionary with the given capacity. |
+ **/ |
+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
capacity:(NSUInteger)numItems; |
+/** |
+ * Initializes a dictionary with the given validation function. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * |
+ * @return A newly initialized dictionary. |
+ **/ |
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func; |
+ |
+/** |
+ * Initializes a dictionary with the entries given. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param values The raw enum values values to be placed in the dictionary. |
+ * @param keys The keys under which to store the values. |
+ * @param count The number of entries to store in the dictionary. |
+ * |
+ * @return A newly initialized dictionary with the keys and values in it. |
+ **/ |
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func |
rawValues:(const int32_t [])values |
forKeys:(const NSString * GPB_UNSAFE_UNRETAINED [])keys |
count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+ |
+/** |
+ * Initializes a dictionary with the entries from the given. |
+ * dictionary. |
+ * |
+ * @param dictionary Dictionary containing the entries to add to the dictionary. |
+ * |
+ * @return A newly initialized dictionary with the entries from the given |
+ * dictionary in it. |
+ **/ |
- (instancetype)initWithDictionary:(GPBStringEnumDictionary *)dictionary; |
+ |
+/** |
+ * Initializes a dictionary with the given capacity. |
+ * |
+ * @param func The enum validation function for the dictionary. |
+ * @param numItems Capacity needed for the dictionary. |
+ * |
+ * @return A newly initialized dictionary with the given capacity. |
+ **/ |
- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func |
capacity:(NSUInteger)numItems; |
@@ -2050,19 +8068,63 @@ NS_ASSUME_NONNULL_BEGIN |
// is not a valid enumerator as defined by validationFunc. If the actual value is |
// desired, use "raw" version of the method. |
-- (BOOL)valueForKey:(NSString *)key value:(nullable int32_t *)value; |
- |
-- (void)enumerateKeysAndValuesUsingBlock: |
+/** |
+ * Gets the value for the given key. |
+ * |
+ * @param value Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getEnum:(nullable int32_t *)value forKey:(NSString *)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **value**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
+- (void)enumerateKeysAndEnumsUsingBlock: |
(void (^)(NSString *key, int32_t value, BOOL *stop))block; |
-// These methods bypass the validationFunc to provide access to values that were not |
-// known at the time the binary was compiled. |
- |
-- (BOOL)valueForKey:(NSString *)key rawValue:(nullable int32_t *)rawValue; |
- |
+/** |
+ * Gets the raw enum value for the given key. |
+ * |
+ * @note This method bypass the validationFunc to enable the access of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param rawValue Pointer into which the value will be set, if found. |
+ * @param key Key under which the value is stored, if present. |
+ * |
+ * @return YES if the key was found and the value was copied, NO otherwise. |
+ **/ |
+- (BOOL)getRawValue:(nullable int32_t *)rawValue forKey:(NSString *)key; |
+ |
+/** |
+ * Enumerates the keys and values on this dictionary with the given block. |
+ * |
+ * @note This method bypass the validationFunc to enable the access of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param block The block to enumerate with. |
+ * **key**: The key for the current entry. |
+ * **rawValue**: The value for the current entry |
+ * **stop**: A pointer to a boolean that when set stops the enumeration. |
+ **/ |
- (void)enumerateKeysAndRawValuesUsingBlock: |
(void (^)(NSString *key, int32_t rawValue, BOOL *stop))block; |
+/** |
+ * Adds the keys and raw enum values from another dictionary. |
+ * |
+ * @note This method bypass the validationFunc to enable the setting of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param otherDictionary Dictionary containing entries to be added to this |
+ * dictionary. |
+ **/ |
- (void)addRawEntriesFromDictionary:(GPBStringEnumDictionary *)otherDictionary; |
// If value is not a valid enumerator as defined by validationFunc, these |
@@ -2070,15 +8132,35 @@ NS_ASSUME_NONNULL_BEGIN |
// to the default value. Use the rawValue methods below to assign non enumerator |
// values. |
-- (void)setValue:(int32_t)value forKey:(NSString *)key; |
- |
-// This method bypass the validationFunc to provide setting of values that were not |
-// known at the time the binary was compiled. |
+/** |
+ * Sets the value for the given key. |
+ * |
+ * @param value The value to set. |
+ * @param key The key under which to store the value. |
+ **/ |
+- (void)setEnum:(int32_t)value forKey:(NSString *)key; |
+ |
+/** |
+ * Sets the raw enum value for the given key. |
+ * |
+ * @note This method bypass the validationFunc to enable the setting of values that |
+ * were not known at the time the binary was compiled. |
+ * |
+ * @param rawValue The raw enum value to set. |
+ * @param key The key under which to store the raw enum value. |
+ **/ |
- (void)setRawValue:(int32_t)rawValue forKey:(NSString *)key; |
-// No validation applies to these methods. |
+/** |
+ * Removes the entry for the given key. |
+ * |
+ * @param aKey Key to be removed from this dictionary. |
+ **/ |
+- (void)removeEnumForKey:(NSString *)aKey; |
-- (void)removeValueForKey:(NSString *)aKey; |
+/** |
+ * Removes all entries in this dictionary. |
+ **/ |
- (void)removeAll; |
@end |
@@ -2107,15 +8189,30 @@ NS_ASSUME_NONNULL_END |
//%DICTIONARY_KEY_TO_POD_INTERFACE(KEY_NAME, KEY_TYPE, KisP, KHELPER, Double, double) |
//%DICTIONARY_KEY_TO_ENUM_INTERFACE(KEY_NAME, KEY_TYPE, KisP, KHELPER, Enum, int32_t) |
//%PDDM-DEFINE DICTIONARY_KEY_TO_POD_INTERFACE(KEY_NAME, KEY_TYPE, KisP, KHELPER, VALUE_NAME, VALUE_TYPE) |
-//%DICTIONARY_COMMON_INTERFACE(KEY_NAME, KEY_TYPE, KisP, KHELPER, VALUE_NAME, VALUE_TYPE, POD, value) |
+//%DICTIONARY_COMMON_INTERFACE(KEY_NAME, KEY_TYPE, KisP, KHELPER, VALUE_NAME, VALUE_TYPE, POD, VALUE_NAME, value) |
//%PDDM-DEFINE DICTIONARY_POD_KEY_TO_OBJECT_INTERFACE(KEY_NAME, KEY_TYPE, VALUE_NAME, VALUE_TYPE) |
-//%DICTIONARY_COMMON_INTERFACE(KEY_NAME, KEY_TYPE, , POD, VALUE_NAME, VALUE_TYPE, OBJECT, object) |
-//%PDDM-DEFINE VALUE_FOR_KEY_POD(KEY_TYPE, VALUE_TYPE) |
-//%- (BOOL)valueForKey:(KEY_TYPE)key value:(nullable VALUE_TYPE *)value; |
-//%PDDM-DEFINE VALUE_FOR_KEY_OBJECT(KEY_TYPE, VALUE_TYPE) |
+//%DICTIONARY_COMMON_INTERFACE(KEY_NAME, KEY_TYPE, , POD, VALUE_NAME, VALUE_TYPE, OBJECT, Object, object) |
+//%PDDM-DEFINE VALUE_FOR_KEY_POD(KEY_TYPE, VALUE_TYPE, VNAME) |
+//%/** |
+//% * Gets the value for the given key. |
+//% * |
+//% * @param value Pointer into which the value will be set, if found. |
+//% * @param key Key under which the value is stored, if present. |
+//% * |
+//% * @return YES if the key was found and the value was copied, NO otherwise. |
+//% **/ |
+//%- (BOOL)get##VNAME##:(nullable VALUE_TYPE *)value forKey:(KEY_TYPE)key; |
+//%PDDM-DEFINE VALUE_FOR_KEY_OBJECT(KEY_TYPE, VALUE_TYPE, VNAME) |
+//%/** |
+//% * Fetches the object stored under the given key. |
+//% * |
+//% * @param key Key under which the value is stored, if present. |
+//% * |
+//% * @return The object if found, nil otherwise. |
+//% **/ |
//%- (VALUE_TYPE)objectForKey:(KEY_TYPE)key; |
-//%PDDM-DEFINE VALUE_FOR_KEY_Enum(KEY_TYPE, VALUE_TYPE) |
-//%VALUE_FOR_KEY_POD(KEY_TYPE, VALUE_TYPE) |
+//%PDDM-DEFINE VALUE_FOR_KEY_Enum(KEY_TYPE, VALUE_TYPE, VNAME) |
+//%VALUE_FOR_KEY_POD(KEY_TYPE, VALUE_TYPE, VNAME) |
//%PDDM-DEFINE ARRAY_ARG_MODIFIERPOD() |
// Nothing |
//%PDDM-DEFINE ARRAY_ARG_MODIFIEREnum() |
@@ -2128,33 +8225,111 @@ NS_ASSUME_NONNULL_END |
//%GPB##KEY_NAME##VALUE_NAME##Dictionary |
//%PDDM-DEFINE DICTIONARY_CLASS_DECLOBJECT(KEY_NAME, VALUE_NAME, VALUE_TYPE) |
//%GPB##KEY_NAME##VALUE_NAME##Dictionary<__covariant VALUE_TYPE> |
-//%PDDM-DEFINE DICTIONARY_COMMON_INTERFACE(KEY_NAME, KEY_TYPE, KisP, KHELPER, VALUE_NAME, VALUE_TYPE, VHELPER, VNAME) |
+//%PDDM-DEFINE DICTIONARY_COMMON_INTERFACE(KEY_NAME, KEY_TYPE, KisP, KHELPER, VALUE_NAME, VALUE_TYPE, VHELPER, VNAME, VNAME_VAR) |
//%#pragma mark - KEY_NAME -> VALUE_NAME |
//% |
+//%/** |
+//% * Class used for map fields of <##KEY_TYPE##, ##VALUE_TYPE##> |
+//% * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+//% * |
+//% * @note This class is not meant to be subclassed. |
+//% **/ |
//%@interface DICTIONARY_CLASS_DECL##VHELPER(KEY_NAME, VALUE_NAME, VALUE_TYPE) : NSObject <NSCopying> |
//% |
+//%/** Number of entries stored in this dictionary. */ |
//%@property(nonatomic, readonly) NSUInteger count; |
//% |
+//%/** |
+//% * @return A newly instanced and empty dictionary. |
+//% **/ |
//%+ (instancetype)dictionary; |
-//%+ (instancetype)dictionaryWith##VNAME$u##:(VALUE_TYPE)##VNAME |
+//% |
+//%/** |
+//% * Creates and initializes a dictionary with the single entry given. |
+//% * |
+//% * @param ##VNAME_VAR The value to be placed in the dictionary. |
+//% * @param key ##VNAME_VAR$S## The key under which to store the value. |
+//% * |
+//% * @return A newly instanced dictionary with the key and value in it. |
+//% **/ |
+//%+ (instancetype)dictionaryWith##VNAME##:(VALUE_TYPE)##VNAME_VAR |
//% ##VNAME$S## forKey:(KEY_TYPE##KisP$S##KisP)key; |
-//%+ (instancetype)dictionaryWith##VNAME$u##s:(const VALUE_TYPE ARRAY_ARG_MODIFIER##VHELPER()[])##VNAME##s |
+//% |
+//%/** |
+//% * Creates and initializes a dictionary with the entries given. |
+//% * |
+//% * @param ##VNAME_VAR##s The values to be placed in the dictionary. |
+//% * @param keys ##VNAME_VAR$S## The keys under which to store the values. |
+//% * @param count ##VNAME_VAR$S## The number of entries to store in the dictionary. |
+//% * |
+//% * @return A newly instanced dictionary with the keys and values in it. |
+//% **/ |
+//%+ (instancetype)dictionaryWith##VNAME##s:(const VALUE_TYPE ARRAY_ARG_MODIFIER##VHELPER()[])##VNAME_VAR##s |
//% ##VNAME$S## forKeys:(const KEY_TYPE##KisP$S##KisP ARRAY_ARG_MODIFIER##KHELPER()[])keys |
//% ##VNAME$S## count:(NSUInteger)count; |
+//% |
+//%/** |
+//% * Creates and initializes a dictionary with the entries from the given. |
+//% * dictionary. |
+//% * |
+//% * @param dictionary Dictionary containing the entries to add to the dictionary. |
+//% * |
+//% * @return A newly instanced dictionary with the entries from the given |
+//% * dictionary in it. |
+//% **/ |
//%+ (instancetype)dictionaryWithDictionary:(GPB##KEY_NAME##VALUE_NAME##Dictionary *)dictionary; |
+//% |
+//%/** |
+//% * Creates and initializes a dictionary with the given capacity. |
+//% * |
+//% * @param numItems Capacity needed for the dictionary. |
+//% * |
+//% * @return A newly instanced dictionary with the given capacity. |
+//% **/ |
//%+ (instancetype)dictionaryWithCapacity:(NSUInteger)numItems; |
//% |
-//%- (instancetype)initWith##VNAME$u##s:(const VALUE_TYPE ARRAY_ARG_MODIFIER##VHELPER()[])##VNAME##s |
+//%/** |
+//% * Initializes this dictionary, copying the given values and keys. |
+//% * |
+//% * @param ##VNAME_VAR##s The values to be placed in this dictionary. |
+//% * @param keys ##VNAME_VAR$S## The keys under which to store the values. |
+//% * @param count ##VNAME_VAR$S## The number of elements to copy into the dictionary. |
+//% * |
+//% * @return A newly initialized dictionary with a copy of the values and keys. |
+//% **/ |
+//%- (instancetype)initWith##VNAME##s:(const VALUE_TYPE ARRAY_ARG_MODIFIER##VHELPER()[])##VNAME_VAR##s |
//% ##VNAME$S## forKeys:(const KEY_TYPE##KisP$S##KisP ARRAY_ARG_MODIFIER##KHELPER()[])keys |
//% ##VNAME$S## count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+//% |
+//%/** |
+//% * Initializes this dictionary, copying the entries from the given dictionary. |
+//% * |
+//% * @param dictionary Dictionary containing the entries to add to this dictionary. |
+//% * |
+//% * @return A newly initialized dictionary with the entries of the given dictionary. |
+//% **/ |
//%- (instancetype)initWithDictionary:(GPB##KEY_NAME##VALUE_NAME##Dictionary *)dictionary; |
+//% |
+//%/** |
+//% * Initializes this dictionary with the requested capacity. |
+//% * |
+//% * @param numItems Number of items needed for this dictionary. |
+//% * |
+//% * @return A newly initialized dictionary with the requested capacity. |
+//% **/ |
//%- (instancetype)initWithCapacity:(NSUInteger)numItems; |
//% |
-//%DICTIONARY_IMMUTABLE_INTERFACE(KEY_NAME, KEY_TYPE, KisP, VALUE_NAME, VALUE_TYPE, VHELPER, VNAME) |
+//%DICTIONARY_IMMUTABLE_INTERFACE(KEY_NAME, KEY_TYPE, KisP, VALUE_NAME, VALUE_TYPE, VHELPER, VNAME, VNAME_VAR) |
//% |
+//%/** |
+//% * Adds the keys and values from another dictionary. |
+//% * |
+//% * @param otherDictionary Dictionary containing entries to be added to this |
+//% * dictionary. |
+//% **/ |
//%- (void)addEntriesFromDictionary:(GPB##KEY_NAME##VALUE_NAME##Dictionary *)otherDictionary; |
//% |
-//%DICTIONARY_MUTABLE_INTERFACE(KEY_NAME, KEY_TYPE, KisP, VALUE_NAME, VALUE_TYPE, VHELPER, VNAME) |
+//%DICTIONARY_MUTABLE_INTERFACE(KEY_NAME, KEY_TYPE, KisP, VALUE_NAME, VALUE_TYPE, VHELPER, VNAME, VNAME_VAR) |
//% |
//%@end |
//% |
@@ -2164,30 +8339,126 @@ NS_ASSUME_NONNULL_END |
//%PDDM-DEFINE DICTIONARY_KEY_TO_ENUM_INTERFACE2(KEY_NAME, KEY_TYPE, KisP, KHELPER, VALUE_NAME, VALUE_TYPE, VHELPER) |
//%#pragma mark - KEY_NAME -> VALUE_NAME |
//% |
+//%/** |
+//% * Class used for map fields of <##KEY_TYPE##, ##VALUE_TYPE##> |
+//% * values. This performs better than boxing into NSNumbers in NSDictionaries. |
+//% * |
+//% * @note This class is not meant to be subclassed. |
+//% **/ |
//%@interface GPB##KEY_NAME##VALUE_NAME##Dictionary : NSObject <NSCopying> |
//% |
+//%/** Number of entries stored in this dictionary. */ |
//%@property(nonatomic, readonly) NSUInteger count; |
+//%/** The validation function to check if the enums are valid. */ |
//%@property(nonatomic, readonly) GPBEnumValidationFunc validationFunc; |
//% |
+//%/** |
+//% * @return A newly instanced and empty dictionary. |
+//% **/ |
//%+ (instancetype)dictionary; |
+//% |
+//%/** |
+//% * Creates and initializes a dictionary with the given validation function. |
+//% * |
+//% * @param func The enum validation function for the dictionary. |
+//% * |
+//% * @return A newly instanced dictionary. |
+//% **/ |
//%+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func; |
+//% |
+//%/** |
+//% * Creates and initializes a dictionary with the single entry given. |
+//% * |
+//% * @param func The enum validation function for the dictionary. |
+//% * @param rawValue The raw enum value to be placed in the dictionary. |
+//% * @param key The key under which to store the value. |
+//% * |
+//% * @return A newly instanced dictionary with the key and value in it. |
+//% **/ |
//%+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
//% rawValue:(VALUE_TYPE)rawValue |
//% forKey:(KEY_TYPE##KisP$S##KisP)key; |
+//% |
+//%/** |
+//% * Creates and initializes a dictionary with the entries given. |
+//% * |
+//% * @param func The enum validation function for the dictionary. |
+//% * @param values The raw enum values values to be placed in the dictionary. |
+//% * @param keys The keys under which to store the values. |
+//% * @param count The number of entries to store in the dictionary. |
+//% * |
+//% * @return A newly instanced dictionary with the keys and values in it. |
+//% **/ |
//%+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
//% rawValues:(const VALUE_TYPE ARRAY_ARG_MODIFIER##VHELPER()[])values |
//% forKeys:(const KEY_TYPE##KisP$S##KisP ARRAY_ARG_MODIFIER##KHELPER()[])keys |
//% count:(NSUInteger)count; |
+//% |
+//%/** |
+//% * Creates and initializes a dictionary with the entries from the given. |
+//% * dictionary. |
+//% * |
+//% * @param dictionary Dictionary containing the entries to add to the dictionary. |
+//% * |
+//% * @return A newly instanced dictionary with the entries from the given |
+//% * dictionary in it. |
+//% **/ |
//%+ (instancetype)dictionaryWithDictionary:(GPB##KEY_NAME##VALUE_NAME##Dictionary *)dictionary; |
+//% |
+//%/** |
+//% * Creates and initializes a dictionary with the given capacity. |
+//% * |
+//% * @param func The enum validation function for the dictionary. |
+//% * @param numItems Capacity needed for the dictionary. |
+//% * |
+//% * @return A newly instanced dictionary with the given capacity. |
+//% **/ |
//%+ (instancetype)dictionaryWithValidationFunction:(nullable GPBEnumValidationFunc)func |
//% capacity:(NSUInteger)numItems; |
//% |
+//%/** |
+//% * Initializes a dictionary with the given validation function. |
+//% * |
+//% * @param func The enum validation function for the dictionary. |
+//% * |
+//% * @return A newly initialized dictionary. |
+//% **/ |
//%- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func; |
+//% |
+//%/** |
+//% * Initializes a dictionary with the entries given. |
+//% * |
+//% * @param func The enum validation function for the dictionary. |
+//% * @param values The raw enum values values to be placed in the dictionary. |
+//% * @param keys The keys under which to store the values. |
+//% * @param count The number of entries to store in the dictionary. |
+//% * |
+//% * @return A newly initialized dictionary with the keys and values in it. |
+//% **/ |
//%- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func |
//% rawValues:(const VALUE_TYPE ARRAY_ARG_MODIFIER##VHELPER()[])values |
//% forKeys:(const KEY_TYPE##KisP$S##KisP ARRAY_ARG_MODIFIER##KHELPER()[])keys |
//% count:(NSUInteger)count NS_DESIGNATED_INITIALIZER; |
+//% |
+//%/** |
+//% * Initializes a dictionary with the entries from the given. |
+//% * dictionary. |
+//% * |
+//% * @param dictionary Dictionary containing the entries to add to the dictionary. |
+//% * |
+//% * @return A newly initialized dictionary with the entries from the given |
+//% * dictionary in it. |
+//% **/ |
//%- (instancetype)initWithDictionary:(GPB##KEY_NAME##VALUE_NAME##Dictionary *)dictionary; |
+//% |
+//%/** |
+//% * Initializes a dictionary with the given capacity. |
+//% * |
+//% * @param func The enum validation function for the dictionary. |
+//% * @param numItems Capacity needed for the dictionary. |
+//% * |
+//% * @return A newly initialized dictionary with the given capacity. |
+//% **/ |
//%- (instancetype)initWithValidationFunction:(nullable GPBEnumValidationFunc)func |
//% capacity:(NSUInteger)numItems; |
//% |
@@ -2195,16 +8466,44 @@ NS_ASSUME_NONNULL_END |
//%// is not a valid enumerator as defined by validationFunc. If the actual value is |
//%// desired, use "raw" version of the method. |
//% |
-//%DICTIONARY_IMMUTABLE_INTERFACE(KEY_NAME, KEY_TYPE, KisP, VALUE_NAME, VALUE_TYPE, VHELPER, value) |
+//%DICTIONARY_IMMUTABLE_INTERFACE(KEY_NAME, KEY_TYPE, KisP, VALUE_NAME, VALUE_TYPE, VHELPER, Enum, value) |
//% |
-//%// These methods bypass the validationFunc to provide access to values that were not |
-//%// known at the time the binary was compiled. |
-//% |
-//%- (BOOL)valueForKey:(KEY_TYPE##KisP$S##KisP)key rawValue:(nullable VALUE_TYPE *)rawValue; |
+//%/** |
+//% * Gets the raw enum value for the given key. |
+//% * |
+//% * @note This method bypass the validationFunc to enable the access of values that |
+//% * were not known at the time the binary was compiled. |
+//% * |
+//% * @param rawValue Pointer into which the value will be set, if found. |
+//% * @param key Key under which the value is stored, if present. |
+//% * |
+//% * @return YES if the key was found and the value was copied, NO otherwise. |
+//% **/ |
+//%- (BOOL)getRawValue:(nullable VALUE_TYPE *)rawValue forKey:(KEY_TYPE##KisP$S##KisP)key; |
//% |
+//%/** |
+//% * Enumerates the keys and values on this dictionary with the given block. |
+//% * |
+//% * @note This method bypass the validationFunc to enable the access of values that |
+//% * were not known at the time the binary was compiled. |
+//% * |
+//% * @param block The block to enumerate with. |
+//% * **key**: The key for the current entry. |
+//% * **rawValue**: The value for the current entry |
+//% * **stop**: A pointer to a boolean that when set stops the enumeration. |
+//% **/ |
//%- (void)enumerateKeysAndRawValuesUsingBlock: |
//% (void (^)(KEY_TYPE KisP##key, VALUE_TYPE rawValue, BOOL *stop))block; |
//% |
+//%/** |
+//% * Adds the keys and raw enum values from another dictionary. |
+//% * |
+//% * @note This method bypass the validationFunc to enable the setting of values that |
+//% * were not known at the time the binary was compiled. |
+//% * |
+//% * @param otherDictionary Dictionary containing entries to be added to this |
+//% * dictionary. |
+//% **/ |
//%- (void)addRawEntriesFromDictionary:(GPB##KEY_NAME##VALUE_NAME##Dictionary *)otherDictionary; |
//% |
//%// If value is not a valid enumerator as defined by validationFunc, these |
@@ -2212,21 +8511,44 @@ NS_ASSUME_NONNULL_END |
//%// to the default value. Use the rawValue methods below to assign non enumerator |
//%// values. |
//% |
-//%DICTIONARY_MUTABLE_INTERFACE(KEY_NAME, KEY_TYPE, KisP, VALUE_NAME, VALUE_TYPE, VHELPER, value) |
+//%DICTIONARY_MUTABLE_INTERFACE(KEY_NAME, KEY_TYPE, KisP, VALUE_NAME, VALUE_TYPE, VHELPER, Enum, value) |
//% |
//%@end |
//% |
-//%PDDM-DEFINE DICTIONARY_IMMUTABLE_INTERFACE(KEY_NAME, KEY_TYPE, KisP, VALUE_NAME, VALUE_TYPE, VHELPER, VNAME) |
-//%VALUE_FOR_KEY_##VHELPER(KEY_TYPE##KisP$S##KisP, VALUE_TYPE) |
+//%PDDM-DEFINE DICTIONARY_IMMUTABLE_INTERFACE(KEY_NAME, KEY_TYPE, KisP, VALUE_NAME, VALUE_TYPE, VHELPER, VNAME, VNAME_VAR) |
+//%VALUE_FOR_KEY_##VHELPER(KEY_TYPE##KisP$S##KisP, VALUE_TYPE, VNAME) |
//% |
-//%- (void)enumerateKeysAnd##VNAME$u##sUsingBlock: |
-//% (void (^)(KEY_TYPE KisP##key, VALUE_TYPE VNAME, BOOL *stop))block; |
- |
-//%PDDM-DEFINE DICTIONARY_MUTABLE_INTERFACE(KEY_NAME, KEY_TYPE, KisP, VALUE_NAME, VALUE_TYPE, VHELPER, VNAME) |
-//%- (void)set##VNAME$u##:(VALUE_TYPE)##VNAME forKey:(KEY_TYPE##KisP$S##KisP)key; |
+//%/** |
+//% * Enumerates the keys and values on this dictionary with the given block. |
+//% * |
+//% * @param block The block to enumerate with. |
+//% * **key**: ##VNAME_VAR$S## The key for the current entry. |
+//% * **VNAME_VAR**: The value for the current entry |
+//% * **stop**: ##VNAME_VAR$S## A pointer to a boolean that when set stops the enumeration. |
+//% **/ |
+//%- (void)enumerateKeysAnd##VNAME##sUsingBlock: |
+//% (void (^)(KEY_TYPE KisP##key, VALUE_TYPE VNAME_VAR, BOOL *stop))block; |
+ |
+//%PDDM-DEFINE DICTIONARY_MUTABLE_INTERFACE(KEY_NAME, KEY_TYPE, KisP, VALUE_NAME, VALUE_TYPE, VHELPER, VNAME, VNAME_VAR) |
+//%/** |
+//% * Sets the value for the given key. |
+//% * |
+//% * @param ##VNAME_VAR The value to set. |
+//% * @param key ##VNAME_VAR$S## The key under which to store the value. |
+//% **/ |
+//%- (void)set##VNAME##:(VALUE_TYPE)##VNAME_VAR forKey:(KEY_TYPE##KisP$S##KisP)key; |
//%DICTIONARY_EXTRA_MUTABLE_METHODS_##VHELPER(KEY_NAME, KEY_TYPE, KisP, VALUE_NAME, VALUE_TYPE) |
-//%- (void)remove##VNAME$u##ForKey:(KEY_TYPE##KisP$S##KisP)aKey; |
+//%/** |
+//% * Removes the entry for the given key. |
+//% * |
+//% * @param aKey Key to be removed from this dictionary. |
+//% **/ |
+//%- (void)remove##VNAME##ForKey:(KEY_TYPE##KisP$S##KisP)aKey; |
+//% |
+//%/** |
+//% * Removes all entries in this dictionary. |
+//% **/ |
//%- (void)removeAll; |
//%PDDM-DEFINE DICTIONARY_EXTRA_MUTABLE_METHODS_POD(KEY_NAME, KEY_TYPE, KisP, VALUE_NAME, VALUE_TYPE) |
@@ -2235,9 +8557,14 @@ NS_ASSUME_NONNULL_END |
// Empty |
//%PDDM-DEFINE DICTIONARY_EXTRA_MUTABLE_METHODS_Enum(KEY_NAME, KEY_TYPE, KisP, VALUE_NAME, VALUE_TYPE) |
//% |
-//%// This method bypass the validationFunc to provide setting of values that were not |
-//%// known at the time the binary was compiled. |
+//%/** |
+//% * Sets the raw enum value for the given key. |
+//% * |
+//% * @note This method bypass the validationFunc to enable the setting of values that |
+//% * were not known at the time the binary was compiled. |
+//% * |
+//% * @param rawValue The raw enum value to set. |
+//% * @param key The key under which to store the raw enum value. |
+//% **/ |
//%- (void)setRawValue:(VALUE_TYPE)rawValue forKey:(KEY_TYPE##KisP$S##KisP)key; |
//% |
-//%// No validation applies to these methods. |
-//% |