blob: 9d674150e3f411441f38558344c0eed9f4f4a861 [file] [log] [blame]
// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc. All rights reserved.
// https://developers.google.com/protocol-buffers/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#import <Foundation/Foundation.h>
#import "GPBRuntimeTypes.h"
// 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
//%PDDM-EXPAND DECLARE_DICTIONARIES()
// This block of code is generated, do not edit it directly.
#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;
/**
* 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 [__nullable])values
forKeys:(const uint32_t [__nullable])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;
/**
* 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 [__nullable])values
forKeys:(const uint32_t [__nullable])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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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 [__nullable])values
forKeys:(const uint32_t [__nullable])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;
/**
* 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 [__nullable])values
forKeys:(const uint32_t [__nullable])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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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 [__nullable])values
forKeys:(const uint32_t [__nullable])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;
/**
* 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 [__nullable])values
forKeys:(const uint32_t [__nullable])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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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 [__nullable])values
forKeys:(const uint32_t [__nullable])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;
/**
* 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 [__nullable])values
forKeys:(const uint32_t [__nullable])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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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 [__nullable])values
forKeys:(const uint32_t [__nullable])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;
/**
* 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 [__nullable])values
forKeys:(const uint32_t [__nullable])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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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 [__nullable])values
forKeys:(const uint32_t [__nullable])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;
/**
* 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 [__nullable])values
forKeys:(const uint32_t [__nullable])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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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 [__nullable])values
forKeys:(const uint32_t [__nullable])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;
/**
* 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 [__nullable])values
forKeys:(const uint32_t [__nullable])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;
/**
* 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;
/**
* 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;
/**
* 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 [__nullable])values
forKeys:(const uint32_t [__nullable])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 [__nullable])values
forKeys:(const uint32_t [__nullable])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;
// These will return kGPBUnrecognizedEnumeratorValue if the value for the key
// is not a valid enumerator as defined by validationFunc. If the actual value is
// desired, use "raw" version of the method.
/**
* 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;
/**
* 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
// methods will assert in debug, and will log in release and assign the value
// to the default value. Use the rawValue methods below to assign non enumerator
// values.
/**
* 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;
/**
* Removes the entry for the given key.
*
* @param aKey Key to be removed from this dictionary.
**/
- (void)removeEnumForKey:(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 __nonnull GPB_UNSAFE_UNRETAINED [__nullable])objects
forKeys:(const uint32_t [__nullable])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 __nonnull GPB_UNSAFE_UNRETAINED [__nullable])objects
forKeys:(const uint32_t [__nullable])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;
/**
* 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 [__nullable])values
forKeys:(const int32_t [__nullable])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;
/**
* 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 [__nullable])values
forKeys:(const int32_t [__nullable])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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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 [__nullable])values
forKeys:(const int32_t [__nullable])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;
/**
* 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 [__nullable])values
forKeys:(const int32_t [__nullable])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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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 [__nullable])values
forKeys:(const int32_t [__nullable])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;
/**
* 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 [__nullable])values
forKeys:(const int32_t [__nullable])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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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 [__nullable])values
forKeys:(const int32_t [__nullable])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;
/**
* 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 [__nullable])values
forKeys:(const int32_t [__nullable])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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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 [__nullable])values
forKeys:(const int32_t [__nullable])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;
/**
* 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 [__nullable])values
forKeys:(const int32_t [__nullable])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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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 [__nullable])values
forKeys:(const int32_t [__nullable])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;
/**
* 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 [__nullable])values
forKeys:(const int32_t [__nullable])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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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 [__nullable])values
forKeys:(const int32_t [__nullable])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;
/**
* 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 [__nullable])values
forKeys:(const int32_t [__nullable])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;
/**
* 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;
/**
* 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;
/**
* 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 [__nullable])values
forKeys:(const int32_t [__nullable])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 [__nullable])values
forKeys:(const int32_t [__nullable])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;
// These will return kGPBUnrecognizedEnumeratorValue if the value for the key
// is not a valid enumerator as defined by validationFunc. If the actual value is
// desired, use "raw" version of the method.
/**
* 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;
/**
* 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
// methods will assert in debug, and will log in release and assign the value
// to the default value. Use the rawValue methods below to assign non enumerator
// values.
/**
* 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;
/**
* Removes the entry for the given key.
*
* @param aKey Key to be removed from this dictionary.
**/
- (void)removeEnumForKey:(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 __nonnull GPB_UNSAFE_UNRETAINED [__nullable])objects
forKeys:(const int32_t [__nullable])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 __nonnull GPB_UNSAFE_UNRETAINED [__nullable])objects
forKeys:(const int32_t [__nullable])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;
/**
* 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 [__nullable])values
forKeys:(const uint64_t [__nullable])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;
/**
* 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 [__nullable])values
forKeys:(const uint64_t [__nullable])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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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 [__nullable])values
forKeys:(const uint64_t [__nullable])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;
/**
* 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 [__nullable])values
forKeys:(const uint64_t [__nullable])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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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 [__nullable])values
forKeys:(const uint64_t [__nullable])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;
/**
* 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 [__nullable])values
forKeys:(const uint64_t [__nullable])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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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 [__nullable])values
forKeys:(const uint64_t [__nullable])keys