GPBDescriptor Class Reference

#import <GPBDescriptor.h>

Inheritance diagram for GPBDescriptor:

Instance Methods
(nullable GPBFieldDescriptor *)	- fieldWithName:
(nullable GPBFieldDescriptor *)	- fieldWithNumber:
(instancetype)	- initWithClass:file:fields:storageSize:wireFormat: [implementation]
(nullable GPBOneofDescriptor *)	- oneofWithName:
(void)	- setupContainingMessageClassName: [implementation]
(void)	- setupExtensionRanges:count: [implementation]
(void)	- setupExtraTextInfo: [implementation]
(void)	- setupMessageClassNameSuffix: [implementation]
(void)	- setupOneofs:count:firstHasIndex: [implementation]

Class Methods
(instancetype)	+ allocDescriptorForClass:rootClass:file:fields:fieldCount:storageSize:flags: [implementation]

Protected Attributes
package NSArray *	fields_
NSArray *	oneofs_
uint32_t	storageSize_

Properties
GPBDescriptor *	containingType
const GPBExtensionRange *	extensionRanges
uint32_t	extensionRangesCount
NSArray< GPBFieldDescriptor * > *	fields
GPBFileDescriptor *	file
NSString *	fullName
Class	messageClass
NSString *	name
NSArray< GPBOneofDescriptor * > *	oneofs
BOOL	wireFormat

Detailed Description

Describes a proto message.

Definition at line 65 of file GPBDescriptor.h.

Method Documentation

allocDescriptorForClass:rootClass:file:fields:fieldCount:storageSize:flags:

+ (instancetype) allocDescriptorForClass: (Class)  messageClass rootClass: (Class)  rootClass file: (GPBFileDescriptor *)  file fields: (void *)  fieldDescriptions fieldCount: (uint32_t)  fieldCount storageSize: (uint32_t)  storageSize flags: (GPBDescriptorInitializationFlags)  flags

implementation

fieldWithName:

- (nullable GPBFieldDescriptor *) fieldWithName:

(NSString *)

name

Gets the field for the given name.

Parameters

name	The name for the field to get.

Returns

The field descriptor for the given name, or nil if not found.

fieldWithNumber:

- (nullable GPBFieldDescriptor *) fieldWithNumber:

(uint32_t)

fieldNumber

Gets the field for the given number.

Parameters

fieldNumber

The number for the field to get.

Returns

The field descriptor for the given number, or nil if not found.

initWithClass:file:fields:storageSize:wireFormat:

- (instancetype) initWithClass: (Class)  messageClass file: (GPBFileDescriptor *)  file fields: (NSArray *)  fields storageSize: (uint32_t)  storage wireFormat: (BOOL)  wireFormat

implementation

oneofWithName:

- (nullable GPBOneofDescriptor *) oneofWithName:

(NSString *)

name

Gets the oneof for the given name.

Parameters

name	The name for the oneof to get.

Returns

The oneof descriptor for the given name, or nil if not found.

setupContainingMessageClassName:

- (void) setupContainingMessageClassName: (const char *)  msgClassName

implementation

setupExtensionRanges:count:

- (void) setupExtensionRanges: (const GPBExtensionRange *)  ranges count: (int32_t)  count

implementation

setupExtraTextInfo:

- (void) setupExtraTextInfo: (const char *)  extraTextFormatInfo

implementation

setupMessageClassNameSuffix:

- (void) setupMessageClassNameSuffix: (NSString *)  suffix

implementation

setupOneofs:count:firstHasIndex:

- (void) setupOneofs: (const char **)  oneofNames count: (uint32_t)  count firstHasIndex: (int32_t)  firstHasIndex

implementation

Member Data Documentation

fields_

- (package NSArray*) fields_

protected

Definition at line 142 of file GPBDescriptor_PackagePrivate.h.

oneofs_

- (NSArray*) oneofs_

protected

Definition at line 143 of file GPBDescriptor_PackagePrivate.h.

storageSize_

- (uint32_t) storageSize_

protected

Definition at line 144 of file GPBDescriptor_PackagePrivate.h.

Property Documentation

containingType

- (GPBDescriptor*) containingType

readatomicassign

Containing message descriptor if this message is nested, or nil otherwise.

Definition at line 85 of file GPBDescriptor.h.

extensionRanges

- (const GPBExtensionRange*) extensionRanges

readnonatomicassign

Extension range declared for the message.

Definition at line 74 of file GPBDescriptor.h.

extensionRangesCount

- (uint32_t) extensionRangesCount

readnonatomicassign

Number of extension ranges declared for the message.

Definition at line 76 of file GPBDescriptor.h.

fields

- (NSArray<GPBFieldDescriptor*>*) fields

readnonatomicstrong

Fields declared in the message.

Definition at line 70 of file GPBDescriptor.h.

file

- (GPBFileDescriptor*) file

readnonatomicassign

Descriptor for the file where the message was defined.

Definition at line 78 of file GPBDescriptor.h.

fullName

- (NSString*) fullName

readatomicassign

Fully qualified name for this message (package.message). Can be nil if the value is unable to be computed.

Definition at line 90 of file GPBDescriptor.h.

messageClass

- (Class) messageClass

readnonatomicassign

The class of this message.

Definition at line 83 of file GPBDescriptor.h.

name

- (NSString*) name

readnonatomiccopy

Name of the message.

Definition at line 68 of file GPBDescriptor.h.

oneofs

- (NSArray<GPBOneofDescriptor*>*) oneofs

readnonatomicstrong

Oneofs declared in the message.

Definition at line 72 of file GPBDescriptor.h.

wireFormat

- (BOOL) wireFormat

readnonatomicassign

Whether the message is in wire format or not.

Definition at line 81 of file GPBDescriptor.h.

---

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

• GPBDescriptor.h