blob: 8837f4cb49d55d0a3c6bbdb0943c0462e690a76a [file] [log] [blame]
Thomas Van Lenten30650d82015-05-01 08:57:16 -04001// 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
31#import <Foundation/Foundation.h>
32
Thomas Van Lentend846b0b2015-06-08 16:24:57 -040033@class GPBUnknownField;
Thomas Van Lenten30650d82015-05-01 08:57:16 -040034
Thomas Van Lenten8c889572015-06-16 16:45:14 -040035NS_ASSUME_NONNULL_BEGIN
36
Sergio Campamá32fadc02016-08-08 07:15:02 -070037/**
38 * A collection of unknown fields. Fields parsed from the binary representation
39 * of a message that are unknown end up in an instance of this set. This only
Protobuf Team Botd4e13272022-11-14 07:46:23 -080040 * applies for files declared with the "proto2" syntax.
Sergio Campamá32fadc02016-08-08 07:15:02 -070041 **/
Protobuf Team Bota185a6e2023-01-27 15:19:53 -080042__attribute__((objc_subclassing_restricted))
43@interface GPBUnknownFieldSet : NSObject<NSCopying>
Thomas Van Lenten30650d82015-05-01 08:57:16 -040044
Sergio Campamá32fadc02016-08-08 07:15:02 -070045/**
46 * Tests to see if the given field number has a value.
47 *
48 * @param number The field number to check.
49 *
50 * @return YES if there is an unknown field for the given field number.
51 **/
Thomas Van Lenten30650d82015-05-01 08:57:16 -040052- (BOOL)hasField:(int32_t)number;
Thomas Van Lenten36650a02016-03-07 12:07:03 -050053
Sergio Campamá32fadc02016-08-08 07:15:02 -070054/**
55 * Fetches the GPBUnknownField for the given field number.
56 *
57 * @param number The field number to look up.
58 *
59 * @return The GPBUnknownField or nil if none found.
60 **/
Thomas Van Lenten8c889572015-06-16 16:45:14 -040061- (nullable GPBUnknownField *)getField:(int32_t)number;
Thomas Van Lenten36650a02016-03-07 12:07:03 -050062
Sergio Campamá32fadc02016-08-08 07:15:02 -070063/**
64 * @return The number of fields in this set.
65 **/
Thomas Van Lenten30650d82015-05-01 08:57:16 -040066- (NSUInteger)countOfFields;
67
Sergio Campamá32fadc02016-08-08 07:15:02 -070068/**
69 * Adds the given field to the set.
70 *
71 * @param field The field to add to the set.
72 **/
Thomas Van Lentend846b0b2015-06-08 16:24:57 -040073- (void)addField:(GPBUnknownField *)field;
Thomas Van Lenten30650d82015-05-01 08:57:16 -040074
Sergio Campamá32fadc02016-08-08 07:15:02 -070075/**
76 * @return An array of the GPBUnknownFields sorted by the field numbers.
77 **/
78- (NSArray<GPBUnknownField *> *)sortedFields;
Thomas Van Lenten30650d82015-05-01 08:57:16 -040079
80@end
Thomas Van Lenten8c889572015-06-16 16:45:14 -040081
82NS_ASSUME_NONNULL_END