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 /// A table of known extensions, searchable by name or field number. When | 38 /** |
39 /// parsing a protocol message that might have extensions, you must provide a | 39 * A table of known extensions, searchable by name or field number. When |
40 /// @c GPBExtensionRegistry in which you have registered any extensions that you | 40 * parsing a protocol message that might have extensions, you must provide a |
41 /// want to be able to parse. Otherwise, those extensions will just be treated | 41 * GPBExtensionRegistry in which you have registered any extensions that you |
42 /// like unknown fields. | 42 * want to be able to parse. Otherwise, those extensions will just be treated |
43 /// | 43 * like unknown fields. |
44 /// The @c *Root classes provide @c +extensionRegistry for the extensions define
d | 44 * |
45 /// in a given file *and* all files it imports. You can also create a | 45 * The *Root classes provide `+extensionRegistry` for the extensions defined |
46 /// @c GPBExtensionRegistry, and merge those registries to handle parsing | 46 * in a given file *and* all files it imports. You can also create a |
47 /// extensions defined from non overlapping files. | 47 * GPBExtensionRegistry, and merge those registries to handle parsing |
48 /// | 48 * extensions defined from non overlapping files. |
49 /// @code | 49 * |
50 /// GPBExtensionRegistry *registry = | 50 * ``` |
51 /// [[[MyProtoFileRoot extensionRegistry] copy] autorelease]; | 51 * GPBExtensionRegistry *registry = [[MyProtoFileRoot extensionRegistry] copy]; |
52 /// [registry addExtension:[OtherMessage neededExtension]; // Not in MyProtoFil
e | 52 * [registry addExtension:[OtherMessage neededExtension]]; // Not in MyProtoFile |
53 /// NSError *parseError = nil; | 53 * NSError *parseError; |
54 /// MyMessage *msg = [MyMessage parseData:data | 54 * MyMessage *msg = [MyMessage parseData:data extensionRegistry:registry error:&
parseError]; |
55 /// extensionRegistry:registry | 55 * ``` |
56 /// error:&parseError]; | 56 **/ |
57 /// @endcode | |
58 @interface GPBExtensionRegistry : NSObject<NSCopying> | 57 @interface GPBExtensionRegistry : NSObject<NSCopying> |
59 | 58 |
60 /// Add the given @c GPBExtensionDescriptor to this registry. | 59 /** |
61 /// | 60 * Adds the given GPBExtensionDescriptor to this registry. |
62 /// @param extension The extension description to add. | 61 * |
| 62 * @param extension The extension description to add. |
| 63 **/ |
63 - (void)addExtension:(GPBExtensionDescriptor *)extension; | 64 - (void)addExtension:(GPBExtensionDescriptor *)extension; |
64 | 65 |
65 /// Adds all the extensions from another registry to this registry. | 66 /** |
66 /// | 67 * Adds all the extensions from another registry to this registry. |
67 /// @param registry The registry to merge into this registry. | 68 * |
| 69 * @param registry The registry to merge into this registry. |
| 70 **/ |
68 - (void)addExtensions:(GPBExtensionRegistry *)registry; | 71 - (void)addExtensions:(GPBExtensionRegistry *)registry; |
69 | 72 |
70 /// Looks for the extension registered for the given field number on a given | 73 /** |
71 /// @c GPBDescriptor. | 74 * Looks for the extension registered for the given field number on a given |
72 /// | 75 * GPBDescriptor. |
73 /// @param descriptor The descriptor to look for a registered extension on. | 76 * |
74 /// @param fieldNumber The field number of an extension to look for. | 77 * @param descriptor The descriptor to look for a registered extension on. |
75 /// | 78 * @param fieldNumber The field number of the extension to look for. |
76 /// @return The registered @c GPBExtensionDescripto or nil if none was found. | 79 * |
| 80 * @return The registered GPBExtensionDescriptor or nil if none was found. |
| 81 **/ |
77 - (nullable GPBExtensionDescriptor *)extensionForDescriptor:(GPBDescriptor *)des
criptor | 82 - (nullable GPBExtensionDescriptor *)extensionForDescriptor:(GPBDescriptor *)des
criptor |
78 fieldNumber:(NSInteger)fieldNumb
er; | 83 fieldNumber:(NSInteger)fieldNumb
er; |
79 | 84 |
80 @end | 85 @end |
81 | 86 |
82 NS_ASSUME_NONNULL_END | 87 NS_ASSUME_NONNULL_END |
OLD | NEW |