GPBUnknownFieldSet.h 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. // Protocol Buffers - Google's data interchange format
  2. // Copyright 2008 Google Inc. All rights reserved.
  3. // https://developers.google.com/protocol-buffers/
  4. //
  5. // Redistribution and use in source and binary forms, with or without
  6. // modification, are permitted provided that the following conditions are
  7. // met:
  8. //
  9. // * Redistributions of source code must retain the above copyright
  10. // notice, this list of conditions and the following disclaimer.
  11. // * Redistributions in binary form must reproduce the above
  12. // copyright notice, this list of conditions and the following disclaimer
  13. // in the documentation and/or other materials provided with the
  14. // distribution.
  15. // * Neither the name of Google Inc. nor the names of its
  16. // contributors may be used to endorse or promote products derived from
  17. // this software without specific prior written permission.
  18. //
  19. // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20. // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21. // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22. // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23. // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24. // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25. // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26. // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27. // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  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.
  30. #import <Foundation/Foundation.h>
  31. @class GPBUnknownField;
  32. NS_ASSUME_NONNULL_BEGIN
  33. /**
  34. * A collection of unknown fields. Fields parsed from the binary representation
  35. * of a message that are unknown end up in an instance of this set. This only
  36. * applies for files declared with the "proto2" syntax. Files declared with the
  37. * "proto3" syntax discard the unknown values.
  38. **/
  39. @interface GPBUnknownFieldSet : NSObject<NSCopying>
  40. /**
  41. * Tests to see if the given field number has a value.
  42. *
  43. * @param number The field number to check.
  44. *
  45. * @return YES if there is an unknown field for the given field number.
  46. **/
  47. - (BOOL)hasField:(int32_t)number;
  48. /**
  49. * Fetches the GPBUnknownField for the given field number.
  50. *
  51. * @param number The field number to look up.
  52. *
  53. * @return The GPBUnknownField or nil if none found.
  54. **/
  55. - (nullable GPBUnknownField *)getField:(int32_t)number;
  56. /**
  57. * @return The number of fields in this set.
  58. **/
  59. - (NSUInteger)countOfFields;
  60. /**
  61. * Adds the given field to the set.
  62. *
  63. * @param field The field to add to the set.
  64. **/
  65. - (void)addField:(GPBUnknownField *)field;
  66. /**
  67. * @return An array of the GPBUnknownFields sorted by the field numbers.
  68. **/
  69. - (NSArray<GPBUnknownField *> *)sortedFields;
  70. @end
  71. NS_ASSUME_NONNULL_END