OLD | NEW |
1 // Protocol Buffers - Google's data interchange format | 1 // Protocol Buffers - Google's data interchange format |
2 // Copyright 2008 Google Inc. All rights reserved. | 2 // Copyright 2008 Google Inc. All rights reserved. |
3 // https://developers.google.com/protocol-buffers/ | 3 // https://developers.google.com/protocol-buffers/ |
4 // | 4 // |
5 // Redistribution and use in source and binary forms, with or without | 5 // Redistribution and use in source and binary forms, with or without |
6 // modification, are permitted provided that the following conditions are | 6 // modification, are permitted provided that the following conditions are |
7 // met: | 7 // met: |
8 // | 8 // |
9 // * Redistributions of source code must retain the above copyright | 9 // * Redistributions of source code must retain the above copyright |
10 // notice, this list of conditions and the following disclaimer. | 10 // notice, this list of conditions and the following disclaimer. |
(...skipping 17 matching lines...) Expand all Loading... |
28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | 28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | 29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
30 | 30 |
31 #import <Foundation/Foundation.h> | 31 #import <Foundation/Foundation.h> |
32 | 32 |
33 @class GPBDescriptor; | 33 @class GPBDescriptor; |
34 @class GPBExtensionDescriptor; | 34 @class GPBExtensionDescriptor; |
35 | 35 |
36 NS_ASSUME_NONNULL_BEGIN | 36 NS_ASSUME_NONNULL_BEGIN |
37 | 37 |
38 /** | 38 /// A table of known extensions, searchable by name or field number. When |
39 * A table of known extensions, searchable by name or field number. When | 39 /// parsing a protocol message that might have extensions, you must provide a |
40 * parsing a protocol message that might have extensions, you must provide a | 40 /// @c GPBExtensionRegistry in which you have registered any extensions that you |
41 * GPBExtensionRegistry in which you have registered any extensions that you | 41 /// want to be able to parse. Otherwise, those extensions will just be treated |
42 * want to be able to parse. Otherwise, those extensions will just be treated | 42 /// like unknown fields. |
43 * like unknown fields. | 43 /// |
44 * | 44 /// The @c *Root classes provide @c +extensionRegistry for the extensions define
d |
45 * The *Root classes provide `+extensionRegistry` for the extensions defined | 45 /// in a given file *and* all files it imports. You can also create a |
46 * in a given file *and* all files it imports. You can also create a | 46 /// @c GPBExtensionRegistry, and merge those registries to handle parsing |
47 * GPBExtensionRegistry, and merge those registries to handle parsing | 47 /// extensions defined from non overlapping files. |
48 * extensions defined from non overlapping files. | 48 /// |
49 * | 49 /// @code |
50 * ``` | 50 /// GPBExtensionRegistry *registry = |
51 * GPBExtensionRegistry *registry = [[MyProtoFileRoot extensionRegistry] copy]; | 51 /// [[[MyProtoFileRoot extensionRegistry] copy] autorelease]; |
52 * [registry addExtension:[OtherMessage neededExtension]]; // Not in MyProtoFile | 52 /// [registry addExtension:[OtherMessage neededExtension]; // Not in MyProtoFil
e |
53 * NSError *parseError; | 53 /// NSError *parseError = nil; |
54 * MyMessage *msg = [MyMessage parseData:data extensionRegistry:registry error:&
parseError]; | 54 /// MyMessage *msg = [MyMessage parseData:data |
55 * ``` | 55 /// extensionRegistry:registry |
56 **/ | 56 /// error:&parseError]; |
| 57 /// @endcode |
57 @interface GPBExtensionRegistry : NSObject<NSCopying> | 58 @interface GPBExtensionRegistry : NSObject<NSCopying> |
58 | 59 |
59 /** | 60 /// Add the given @c GPBExtensionDescriptor to this registry. |
60 * Adds the given GPBExtensionDescriptor to this registry. | 61 /// |
61 * | 62 /// @param extension The extension description to add. |
62 * @param extension The extension description to add. | |
63 **/ | |
64 - (void)addExtension:(GPBExtensionDescriptor *)extension; | 63 - (void)addExtension:(GPBExtensionDescriptor *)extension; |
65 | 64 |
66 /** | 65 /// Adds all the extensions from another registry to this registry. |
67 * Adds all the extensions from another registry to this registry. | 66 /// |
68 * | 67 /// @param registry The registry to merge into this registry. |
69 * @param registry The registry to merge into this registry. | |
70 **/ | |
71 - (void)addExtensions:(GPBExtensionRegistry *)registry; | 68 - (void)addExtensions:(GPBExtensionRegistry *)registry; |
72 | 69 |
73 /** | 70 /// Looks for the extension registered for the given field number on a given |
74 * Looks for the extension registered for the given field number on a given | 71 /// @c GPBDescriptor. |
75 * GPBDescriptor. | 72 /// |
76 * | 73 /// @param descriptor The descriptor to look for a registered extension on. |
77 * @param descriptor The descriptor to look for a registered extension on. | 74 /// @param fieldNumber The field number of an extension to look for. |
78 * @param fieldNumber The field number of the extension to look for. | 75 /// |
79 * | 76 /// @return The registered @c GPBExtensionDescripto or nil if none was found. |
80 * @return The registered GPBExtensionDescriptor or nil if none was found. | |
81 **/ | |
82 - (nullable GPBExtensionDescriptor *)extensionForDescriptor:(GPBDescriptor *)des
criptor | 77 - (nullable GPBExtensionDescriptor *)extensionForDescriptor:(GPBDescriptor *)des
criptor |
83 fieldNumber:(NSInteger)fieldNumb
er; | 78 fieldNumber:(NSInteger)fieldNumb
er; |
84 | 79 |
85 @end | 80 @end |
86 | 81 |
87 NS_ASSUME_NONNULL_END | 82 NS_ASSUME_NONNULL_END |
OLD | NEW |