GPBFieldDescriptor Class Reference

#import <GPBDescriptor.h>

Inheritance diagram for GPBFieldDescriptor:

Instance Methods
(instancetype)	- initWithFieldDescription:includesDefault:syntax: [implementation]
(BOOL)	- isValidEnumValue:
(nullable NSString *)	- textFormatName

Protected Attributes
GPB_UNSAFE_UNRETAINED GPBOneofDescriptor *	containingOneof_
package GPBMessageFieldDescription *	description_
SEL	getSel_
SEL	hasOrCountSel_
SEL	setHasSel_
SEL	setSel_

Properties
GPBOneofDescriptor *	containingOneof
GPBDataType	dataType
GPBGenericValue	defaultValue
GPBEnumDescriptor *	enumDescriptor
GPBFieldType	fieldType
BOOL	hasDefaultValue
GPBDataType	mapKeyDataType
Class	msgClass
NSString *	name
uint32_t	number
BOOL	optional
BOOL	packable
BOOL	required

Detailed Description

Describes a proto field.

Definition at line 167 of file GPBDescriptor.h.

Method Documentation

initWithFieldDescription:includesDefault:syntax:

- (instancetype) initWithFieldDescription: (void *)  description includesDefault: (BOOL)  includesDefault syntax: (GPBFileSyntax)  syntax

implementation

isValidEnumValue:

- (BOOL) isValidEnumValue:

(int32_t)

value

Checks whether the given enum raw value is a valid enum value.

Parameters

value

The raw enum value to check.

Returns

YES if value is a valid enum raw value.

textFormatName

- (nullable NSString *) textFormatName

Returns

Name for the text format, or nil if not known.

Member Data Documentation

containingOneof_

- (GPB_UNSAFE_UNRETAINED GPBOneofDescriptor*) containingOneof_

protected

Definition at line 197 of file GPBDescriptor_PackagePrivate.h.

description_

- (package GPBMessageFieldDescription*) description_

protected

Definition at line 196 of file GPBDescriptor_PackagePrivate.h.

getSel_

- (SEL) getSel_

protected

Definition at line 199 of file GPBDescriptor_PackagePrivate.h.

hasOrCountSel_

- (SEL) hasOrCountSel_

protected

Definition at line 201 of file GPBDescriptor_PackagePrivate.h.

setHasSel_

- (SEL) setHasSel_

protected

Definition at line 202 of file GPBDescriptor_PackagePrivate.h.

setSel_

- (SEL) setSel_

protected

Definition at line 200 of file GPBDescriptor_PackagePrivate.h.

Property Documentation

containingOneof

- (GPBOneofDescriptor*) containingOneof

readnonatomicassign

The containing oneof if this field is part of one, nil otherwise.

Definition at line 191 of file GPBDescriptor.h.

dataType

- (GPBDataType) dataType

readnonatomicassign

Data type contained in the field.

Definition at line 174 of file GPBDescriptor.h.

defaultValue

- (GPBGenericValue) defaultValue

readnonatomicassign

Default value for the field.

Definition at line 178 of file GPBDescriptor.h.

enumDescriptor

- (GPBEnumDescriptor*) enumDescriptor

readnonatomicstrong

Descriptor for the enum if this field is an enum.

Definition at line 197 of file GPBDescriptor.h.

fieldType

- (GPBFieldType) fieldType

readnonatomicassign

Type of field (single, repeated, map).

Definition at line 184 of file GPBDescriptor.h.

hasDefaultValue

- (BOOL) hasDefaultValue

readnonatomicassign

Whether it has a default value or not.

Definition at line 176 of file GPBDescriptor.h.

mapKeyDataType

- (GPBDataType) mapKeyDataType

readnonatomicassign

Type of the key if the field is a map. The value's type is -fieldType.

Definition at line 186 of file GPBDescriptor.h.

msgClass

- (Class) msgClass

readnonatomicassign

Class of the message if the field is of message type.

Definition at line 194 of file GPBDescriptor.h.

name

- (NSString*) name

readnonatomiccopy

Name of the field.

Definition at line 170 of file GPBDescriptor.h.

number

- (uint32_t) number

readnonatomicassign

Number associated with the field.

Definition at line 172 of file GPBDescriptor.h.

optional

- (BOOL) optional

readnonatomicassign

Whether this field is optional.

Definition at line 182 of file GPBDescriptor.h.

packable

- (BOOL) packable

readnonatomicassign

Whether the field is packable.

Definition at line 188 of file GPBDescriptor.h.

required

- (BOOL) required

readnonatomicassign

Whether this field is required. Only valid for proto2 fields.

Definition at line 180 of file GPBDescriptor.h.

---

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

• GPBDescriptor.h