GPBBoolEnumDictionary Class Reference

#import <GPBDictionary.h>

Inheritance diagram for GPBBoolEnumDictionary:

Instance Methods
(void)	- addRawEntriesFromDictionary:
(void)	- enumerateKeysAndEnumsUsingBlock:
(void)	- enumerateKeysAndRawValuesUsingBlock:
(BOOL)	- getEnum:forKey:
(BOOL)	- getRawValue:forKey:
(instancetype)	- initWithDictionary:
(instancetype)	- initWithValidationFunction:
(instancetype)	- initWithValidationFunction:capacity:
(instancetype)	- initWithValidationFunction:rawValues:forKeys:count:
(void)	- removeAll
(void)	- removeEnumForKey:
(NSData *)	- serializedDataForUnknownValue:forKey:keyDataType: [implementation]
(void)	- setEnum:forKey:
(void)	- setRawValue:forKey:
Instance Methods inherited from <GPBDictionaryInternalsProtocol>
(size_t)	- computeSerializedSizeAsField:
(void)	- enumerateForTextFormat:
(void)	- setGPBGenericValue:forGPBGenericValueKey:
(void)	- writeToCodedOutputStream:asField:

Protected Attributes
package GPB_UNSAFE_UNRETAINED GPBMessage *	_autocreator

Properties
NSUInteger	count
GPBEnumValidationFunc	validationFunc

Detailed Description

Class used for map fields of <BOOL, int32_t> values. This performs better than boxing into NSNumbers in NSDictionaries.

Note

This class is not meant to be subclassed.

Definition at line 4406 of file GPBDictionary.h.

Method Documentation

addRawEntriesFromDictionary:

- (void) addRawEntriesFromDictionary:

(GPBBoolEnumDictionary *)

otherDictionary

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.

Parameters

otherDictionary

Dictionary containing entries to be added to this dictionary.

enumerateKeysAndEnumsUsingBlock:

- (void) enumerateKeysAndEnumsUsingBlock:

(void(NS_NOESCAPE ^ block)(BOOL key, int32_t value, BOOL *stop))

Enumerates the keys and values on this dictionary with the given block.

Parameters

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.

enumerateKeysAndRawValuesUsingBlock:

- (void) enumerateKeysAndRawValuesUsingBlock:

(void(NS_NOESCAPE ^ block)(BOOL key, int32_t rawValue, BOOL *stop))

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.

Parameters

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.

getEnum:forKey:

- (BOOL) getEnum:		(nullable int32_t *)	value
forKey:		(BOOL)	key

Gets the value for the given key.

Parameters

value	Pointer into which the value will be set, if found.
key	Key under which the value is stored, if present.

Returns

YES if the key was found and the value was copied, NO otherwise.

getRawValue:forKey:

- (BOOL) getRawValue:		(nullable int32_t *)	rawValue
forKey:		(BOOL)	key

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.

Parameters

rawValue	Pointer into which the value will be set, if found.
key	Key under which the value is stored, if present.

Returns

YES if the key was found and the value was copied, NO otherwise.

initWithDictionary:

- (instancetype) initWithDictionary:

(GPBBoolEnumDictionary *)

dictionary

Initializes a dictionary with the entries from the given. dictionary.

Parameters

dictionary

Dictionary containing the entries to add to the dictionary.

Returns

A newly initialized dictionary with the entries from the given dictionary in it.

initWithValidationFunction:

- (instancetype) initWithValidationFunction:

(nullable GPBEnumValidationFunc)

func

Initializes a dictionary with the given validation function.

Parameters

func	The enum validation function for the dictionary.

Returns

A newly initialized dictionary.

initWithValidationFunction:capacity:

- (instancetype) initWithValidationFunction:		(nullable GPBEnumValidationFunc)	func
capacity:		(NSUInteger)	numItems

Initializes a dictionary with the given capacity.

Parameters

func	The enum validation function for the dictionary.
numItems	Capacity needed for the dictionary.

Returns

A newly initialized dictionary with the given capacity.

initWithValidationFunction:rawValues:forKeys:count:

- (instancetype) initWithValidationFunction:		(nullable GPBEnumValidationFunc)	func
rawValues:		(const int32_t)	values[__nullable]
forKeys:		(const BOOL)	keys[__nullable]
count:		(NSUInteger)	NS_DESIGNATED_INITIALIZER

Initializes a dictionary with the entries given.

Parameters

func	The enum validation function for the dictionary.
values	The raw enum values values to be placed in the dictionary.
keys	The keys under which to store the values.
count	The number of entries to store in the dictionary.

Returns

A newly initialized dictionary with the keys and values in it.

removeAll

- (void) removeAll

Removes all entries in this dictionary.

removeEnumForKey:

- (void) removeEnumForKey:

(BOOL)

aKey

Removes the entry for the given key.

Parameters

aKey	Key to be removed from this dictionary.

serializedDataForUnknownValue:forKey:keyDataType:

- (NSData *) serializedDataForUnknownValue: (int32_t)  value forKey: (GPBGenericValue *)  key keyDataType: (GPBDataType)  keyDataType

implementation

setEnum:forKey:

- (void) setEnum:		(int32_t)	value
forKey:		(BOOL)	key

Sets the value for the given key.

Parameters

value	The value to set.
key	The key under which to store the value.

setRawValue:forKey:

- (void) setRawValue:		(int32_t)	rawValue
forKey:		(BOOL)	key

Sets the raw enum value for the given key.

Note

This method bypass the validationFunc to enable the setting of values that were not known at the time the binary was compiled.

Parameters

rawValue	The raw enum value to set.
key	The key under which to store the raw enum value.

Member Data Documentation

_autocreator

- (package GPB_UNSAFE_UNRETAINED GPBMessage*) _autocreator

protected

Definition at line 382 of file GPBDictionary_PackagePrivate.h.

Property Documentation

count

- (NSUInteger) count

readnonatomicassign

Number of entries stored in this dictionary.

Definition at line 4409 of file GPBDictionary.h.

validationFunc

- (GPBEnumValidationFunc) validationFunc

readnonatomicassign

The validation function to check if the enums are valid.

Definition at line 4411 of file GPBDictionary.h.

---

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

• GPBDictionary.h