aboutsummaryrefslogtreecommitdiffstats
path: root/java/src/main/java/com/google/protobuf/nano/ExtendableMessageNano.java
blob: 4fe8dce024d22a3456be57b53197666e73161b8b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
// Protocol Buffers - Google's data interchange format
// Copyright 2013 Google Inc.  All rights reserved.
// http://code.google.com/p/protobuf/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package com.google.protobuf.nano;

import java.io.IOException;

/**
 * Base class of those Protocol Buffer messages that need to store unknown fields,
 * such as extensions.
 */
public abstract class ExtendableMessageNano<M extends ExtendableMessageNano<M>>
        extends MessageNano {
    /**
     * A container for fields unknown to the message, including extensions. Extension fields can
     * can be accessed through the {@link #getExtension} and {@link #setExtension} methods.
     */
    protected FieldArray unknownFieldData;

    @Override
    protected int computeSerializedSize() {
        int size = 0;
        if (unknownFieldData != null) {
            for (int i = 0; i < unknownFieldData.size(); i++) {
                FieldData field = unknownFieldData.dataAt(i);
                size += field.computeSerializedSize();
            }
        }
        return size;
    }

    @Override
    public void writeTo(CodedOutputByteBufferNano output) throws IOException {
        if (unknownFieldData == null) {
            return;
        }
        for (int i = 0; i < unknownFieldData.size(); i++) {
            FieldData field = unknownFieldData.dataAt(i);
            field.writeTo(output);
        }
    }

    /**
     * Checks if there is a value stored for the specified extension in this
     * message.
     */
    public final boolean hasExtension(Extension<M, ?> extension) {
        if (unknownFieldData == null) {
            return false;
        }
        FieldData field = unknownFieldData.get(WireFormatNano.getTagFieldNumber(extension.tag));
        return field != null;
    }

    /**
     * Gets the value stored in the specified extension of this message.
     */
    public final <T> T getExtension(Extension<M, T> extension) {
        if (unknownFieldData == null) {
            return null;
        }
        FieldData field = unknownFieldData.get(WireFormatNano.getTagFieldNumber(extension.tag));
        return field == null ? null : field.getValue(extension);
    }

    /**
     * Sets the value of the specified extension of this message.
     */
    public final <T> M setExtension(Extension<M, T> extension, T value) {
        int fieldNumber = WireFormatNano.getTagFieldNumber(extension.tag);
        if (value == null) {
            if (unknownFieldData != null) {
                unknownFieldData.remove(fieldNumber);
                if (unknownFieldData.isEmpty()) {
                    unknownFieldData = null;
                }
            }
        } else {
            FieldData field = null;
            if (unknownFieldData == null) {
                unknownFieldData = new FieldArray();
            } else {
                field = unknownFieldData.get(fieldNumber);
            }
            if (field == null) {
                unknownFieldData.put(fieldNumber, new FieldData(extension, value));
            } else {
                field.setValue(extension, value);
            }
        }

        @SuppressWarnings("unchecked") // Generated code should guarantee type safety
        M typedThis = (M) this;
        return typedThis;
    }

    /**
     * Stores the binary data of an unknown field.
     *
     * <p>Generated messages will call this for unknown fields if the store_unknown_fields
     * option is on.
     *
     * <p>Note that the tag might be a end-group tag (rather than the start of an unknown field) in
     * which case we do not want to add an unknown field entry.
     *
     * @param input the input buffer.
     * @param tag the tag of the field.

     * @return {@literal true} unless the tag is an end-group tag.
     */
    protected final boolean storeUnknownField(CodedInputByteBufferNano input, int tag)
            throws IOException {
        int startPos = input.getPosition();
        if (!input.skipField(tag)) {
            return false;  // This wasn't an unknown field, it's an end-group tag.
        }
        int fieldNumber = WireFormatNano.getTagFieldNumber(tag);
        int endPos = input.getPosition();
        byte[] bytes = input.getData(startPos, endPos - startPos);
        UnknownFieldData unknownField = new UnknownFieldData(tag, bytes);

        FieldData field = null;
        if (unknownFieldData == null) {
            unknownFieldData = new FieldArray();
        } else {
            field = unknownFieldData.get(fieldNumber);
        }
        if (field == null) {
            field = new FieldData();
            unknownFieldData.put(fieldNumber, field);
        }
        field.addUnknownField(unknownField);
        return true;
    }

    @Override
    public M clone() throws CloneNotSupportedException {
        M cloned = (M) super.clone();
        InternalNano.cloneUnknownFieldData(this, cloned);
        return cloned;
    }
}