GPBEnumArray Class Reference

#import <GPBArray.h>

Inheritance diagram for GPBEnumArray:

Instance Methods
(void)	- addRawValue:
(void)	- addRawValues:count:
(void)	- addRawValuesFromArray:
(void)	- addValue:
(void)	- addValues:count:
(void)	- enumerateRawValuesWithBlock:
(void)	- enumerateRawValuesWithOptions:usingBlock:
(void)	- enumerateValuesWithBlock:
(void)	- enumerateValuesWithOptions:usingBlock:
(void)	- exchangeValueAtIndex:withValueAtIndex:
(instancetype)	- initWithValidationFunction:
(instancetype)	- initWithValidationFunction:capacity:
(instancetype)	- initWithValidationFunction:rawValues:count:
(instancetype)	- initWithValueArray:
(void)	- insertRawValue:atIndex:
(void)	- insertValue:atIndex:
(int32_t)	- rawValueAtIndex:
(void)	- removeAll
(void)	- removeValueAtIndex:
(void)	- replaceValueAtIndex:withRawValue:
(void)	- replaceValueAtIndex:withValue:
(int32_t)	- valueAtIndex:

Class Methods
(instancetype)	+ array
(instancetype)	+ arrayWithValidationFunction:
(instancetype)	+ arrayWithValidationFunction:capacity:
(instancetype)	+ arrayWithValidationFunction:rawValue:
(instancetype)	+ arrayWithValueArray:

Protected Attributes
package GPB_UNSAFE_UNRETAINED GPBMessage *	_autocreator

Properties
NSUInteger	count
GPBEnumValidationFunc	validationFunc

Detailed Description

This class is used for repeated fields of int32_t values. This performs better than boxing into NSNumbers in NSArrays.

Note

This class is not meant to be subclassed.

Definition at line 1252 of file GPBArray.h.

Method Documentation

addRawValue:

- (void) addRawValue:

(int32_t)

value

Adds a raw enum value to this array.

Note

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

Parameters

value

The raw enum value to add to the array.

addRawValues:count:

- (void) addRawValues:		(const int32_t)	values[__nullable]
count:		(NSUInteger)	count

Adds raw enum values to this array.

Note

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

Parameters

values	Array containing the raw enum values to add to this array.
count	The number of raw values to add.

addRawValuesFromArray:

- (void) addRawValuesFromArray:

(GPBEnumArray *)

array

Adds raw enum values to this array.

Note

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

Parameters

array

Array containing the raw enum values to add to this array.

addValue:

- (void) addValue:

(int32_t)

value

Adds a value to this array.

Parameters

value

The value to add to this array.

addValues:count:

- (void) addValues:		(const int32_t)	values[__nullable]
count:		(NSUInteger)	count

Adds values to this array.

Parameters

values	The values to add to this array.
count	The number of elements to add.

array

+ (instancetype) array

Returns

A newly instanced and empty GPBEnumArray.

arrayWithValidationFunction:

+ (instancetype) arrayWithValidationFunction:

(nullable GPBEnumValidationFunc)

func

Creates and initializes a GPBEnumArray with the enum validation function given.

Parameters

func	The enum validation function for the array.

Returns

A newly instanced GPBEnumArray.

arrayWithValidationFunction:capacity:

+ (instancetype) arrayWithValidationFunction:		(nullable GPBEnumValidationFunc)	func
capacity:		(NSUInteger)	count

Creates and initializes a GPBEnumArray with the given enum validation function and with the givencapacity.

Parameters

func	The enum validation function for the array.
count	The capacity needed for the array.

Returns

A newly instanced GPBEnumArray with a capacity of count.

arrayWithValidationFunction:rawValue:

+ (instancetype) arrayWithValidationFunction:		(nullable GPBEnumValidationFunc)	func
rawValue:		(int32_t)	value

Creates and initializes a GPBEnumArray with the enum validation function given and the single raw value given.

Parameters

func	The enum validation function for the array.
value	The raw value to add to this array.

Returns

A newly instanced GPBEnumArray.

arrayWithValueArray:

+ (instancetype) arrayWithValueArray:

(GPBEnumArray *)

array

Creates and initializes a GPBEnumArray that adds the elements from the given array.

Parameters

array

Array containing the values to add to the new array.

Returns

A newly instanced GPBEnumArray.

enumerateRawValuesWithBlock:

- (void) enumerateRawValuesWithBlock:

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

Enumerates the values on this array with the given block.

Parameters

block

The block to enumerate with. value: The current value being enumerated. idx: The index of the current value. stop: A pointer to a boolean that when set stops the enumeration.

enumerateRawValuesWithOptions:usingBlock:

- (void) enumerateRawValuesWithOptions:		(NSEnumerationOptions)	opts
usingBlock:		(void(NS_NOESCAPE ^ block)(int32_t value, NSUInteger idx, BOOL *stop))

Enumerates the values on this array with the given block.

Parameters

opts	Options to control the enumeration.
block	The block to enumerate with. value: The current value being enumerated. idx: The index of the current value. stop: A pointer to a boolean that when set stops the enumeration.

enumerateValuesWithBlock:

- (void) enumerateValuesWithBlock:

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

Enumerates the values on this array with the given block.

Parameters

block

The block to enumerate with. value: The current value being enumerated. idx: The index of the current value. stop: A pointer to a boolean that when set stops the enumeration.

enumerateValuesWithOptions:usingBlock:

- (void) enumerateValuesWithOptions:		(NSEnumerationOptions)	opts
usingBlock:		(void(NS_NOESCAPE ^ block)(int32_t value, NSUInteger idx, BOOL *stop))

Enumerates the values on this array with the given block.

Parameters

opts	Options to control the enumeration.
block	The block to enumerate with. value: The current value being enumerated. idx: The index of the current value. stop: A pointer to a boolean that when set stops the enumeration.

exchangeValueAtIndex:withValueAtIndex:

- (void) exchangeValueAtIndex:		(NSUInteger)	idx1
withValueAtIndex:		(NSUInteger)	idx2

Exchanges the values between the given indexes.

Parameters

idx1	The index of the first element to exchange.
idx2	The index of the second element to exchange.

initWithValidationFunction:

- (instancetype) initWithValidationFunction:

(nullable GPBEnumValidationFunc)

NS_DESIGNATED_INITIALIZER

Initializes the array with the given enum validation function.

Parameters

func	The enum validation function for the array.

Returns

A newly initialized GPBEnumArray with a copy of the values.

initWithValidationFunction:capacity:

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

Initializes the array with the given capacity.

Parameters

func	The enum validation function for the array.
count	The capacity needed for the array.

Returns

A newly initialized GPBEnumArray with a capacity of count.

initWithValidationFunction:rawValues:count:

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

Initializes the array, copying the given values.

Parameters

func	The enum validation function for the array.
values	An array with the values to put inside this array.
count	The number of elements to copy into the array.

Returns

A newly initialized GPBEnumArray with a copy of the values.

initWithValueArray:

- (instancetype) initWithValueArray:

(GPBEnumArray *)

array

Initializes the array, copying the given values.

Parameters

array

An array with the values to put inside this array.

Returns

A newly initialized GPBEnumArray with a copy of the values.

insertRawValue:atIndex:

- (void) insertRawValue:		(int32_t)	value
atIndex:		(NSUInteger)	index

Inserts a raw enum value at the given index.

Note

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

Parameters

value	Raw enum value to add.
index	The index into which to insert the value.

insertValue:atIndex:

- (void) insertValue:		(int32_t)	value
atIndex:		(NSUInteger)	index

Inserts a value into the given position.

Parameters

value	The value to add to this array.
index	The index into which to insert the value.

rawValueAtIndex:

- (int32_t) rawValueAtIndex:

(NSUInteger)

index

Gets the raw enum value at the given index.

Parameters

index

The index of the raw enum value to get.

Returns

The raw enum value at the given index.

removeAll

- (void) removeAll

Removes all the values from this array.

removeValueAtIndex:

- (void) removeValueAtIndex:

(NSUInteger)

index

Removes the value at the given index.

Parameters

index

The index of the value to remove.

replaceValueAtIndex:withRawValue:

- (void) replaceValueAtIndex:		(NSUInteger)	index
withRawValue:		(int32_t)	value

Replaces the raw enum value at the given index with the given value.

Note

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

Parameters

index	The index for which to replace the value.
value	The raw enum value to replace with.

replaceValueAtIndex:withValue:

- (void) replaceValueAtIndex:		(NSUInteger)	index
withValue:		(int32_t)	value

Replaces the value at the given index with the given value.

Parameters

index	The index for which to replace the value.
value	The value to replace with.

valueAtIndex:

- (int32_t) valueAtIndex:

(NSUInteger)

index

Gets the value at the given index.

Parameters

index

The index of the value to get.

Returns

The value at the given index.

Member Data Documentation

_autocreator

- (package GPB_UNSAFE_UNRETAINED GPBMessage*) _autocreator

protected

Definition at line 118 of file GPBArray_PackagePrivate.h.

Property Documentation

count

- (NSUInteger) count

readnonatomicassign

The number of elements contained in the array.

Definition at line 1255 of file GPBArray.h.

validationFunc

- (GPBEnumValidationFunc) validationFunc

readnonatomicassign

The validation function to check if the enums are valid.

Definition at line 1257 of file GPBArray.h.

---

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

• GPBArray.h