aboutsummaryrefslogtreecommitdiff
path: root/csharp/ProtocolBuffers/GeneratedBuilder.cs
blob: f11ed452d18729c572d4fb3c04639b4c32aab52c (plain) (blame)
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
using System;
using System.Collections.Generic;
using System.Text;
using Google.ProtocolBuffers.Collections;
using Google.ProtocolBuffers.Descriptors;
using System.IO;

namespace Google.ProtocolBuffers {
  /// <summary>
  /// All generated protocol message builder classes extend this class. It implements
  /// most of the IBuilder interface using reflection. Users can ignore this class
  /// as an implementation detail.
  /// </summary>
  public abstract class GeneratedBuilder<TMessage, TBuilder> : AbstractBuilder, IBuilder<TMessage>
      where TMessage : GeneratedMessage <TMessage, TBuilder>
      where TBuilder : GeneratedBuilder<TMessage, TBuilder>, IBuilder<TMessage> {

    /// <summary>
    /// Returns the message being built at the moment.
    /// </summary>
    protected abstract TMessage MessageBeingBuilt { get; }

    public override bool Initialized {
      get { return MessageBeingBuilt.IsInitialized; }
    }

    public override IDictionary<FieldDescriptor, object> AllFields {
      get { return MessageBeingBuilt.AllFields; }
    }

    public override object this[FieldDescriptor field] {
      get {
        // For repeated fields, the underlying list object is still modifiable at this point.
        // Make sure not to expose the modifiable list to the caller.
        return field.IsRepeated
          ? MessageBeingBuilt.InternalFieldAccessors[field].GetRepeatedWrapper(this)
          : MessageBeingBuilt[field];
      }
      set {
        MessageBeingBuilt.InternalFieldAccessors[field].SetValue(this, value);
      }
    }

    /// <summary>
    /// Adds all of the specified values to the given collection.
    /// </summary>
    protected void AddRange<T>(IEnumerable<T> source, IList<T> destination) {
      List<T> list = destination as List<T>;
      if (list != null) {
        list.AddRange(source);
      } else {
        foreach (T element in source) {
          destination.Add(element);
        }
      }
    }

    /// <summary>
    /// Called by derived classes to parse an unknown field.
    /// </summary>
    /// <returns>true unless the tag is an end-group tag</returns>
    protected bool ParseUnknownField(CodedInputStream input, UnknownFieldSet.Builder unknownFields,
                                     ExtensionRegistry extensionRegistry, uint tag) {
      return unknownFields.MergeFieldFrom(tag, input);
    }

    public override MessageDescriptor DescriptorForType {
      get { return MessageBeingBuilt.DescriptorForType; }
    }

    public override int GetRepeatedFieldCount(FieldDescriptor field) {
      return MessageBeingBuilt.GetRepeatedFieldCount(field);
    }

    public override object this[FieldDescriptor field, int index] {
      get { return MessageBeingBuilt[field, index]; }
      set { MessageBeingBuilt.InternalFieldAccessors[field].SetRepeated(this, index, value); }
    }

    public override bool HasField(FieldDescriptor field) {
      return MessageBeingBuilt.HasField(field);
    }

    protected override IMessage BuildImpl() {
      return Build();
    }

    protected override IMessage BuildPartialImpl() {
      return BuildPartial();
    }

    protected override IBuilder CloneImpl() {
      return Clone();
    }

    protected override IMessage DefaultInstanceForTypeImpl {
      get { return DefaultInstanceForType; }
    }

    public override IBuilder CreateBuilderForField(FieldDescriptor field) {
      return MessageBeingBuilt.InternalFieldAccessors[field].CreateBuilder();
    }

    protected override IBuilder ClearFieldImpl(FieldDescriptor field) {
      return ClearField(field);
    }

    protected override IBuilder AddRepeatedFieldImpl(FieldDescriptor field, object value) {
      return AddRepeatedField(field, value);
    }

    public IBuilder<TMessage> ClearField(FieldDescriptor field) {
      MessageBeingBuilt.InternalFieldAccessors[field].Clear(this);
      return this;
    }

    // FIXME: Implement!
    public virtual IBuilder<TMessage> MergeFrom(TMessage other) { return this; }
    public virtual IBuilder<TMessage> MergeUnknownFields(UnknownFieldSet unknownFields) { return this; }

    public IBuilder<TMessage> AddRepeatedField(FieldDescriptor field, object value) {
      MessageBeingBuilt.InternalFieldAccessors[field].AddRepeated(this, value);
      return this;
    }

    public IBuilder<TMessage> MergeFrom(ByteString data) {
      ((IBuilder) this).MergeFrom(data);
      return this;
    }

    public IBuilder<TMessage> MergeFrom(ByteString data, ExtensionRegistry extensionRegistry) {
      ((IBuilder) this).MergeFrom(data, extensionRegistry);
      return this;
    }

    public IBuilder<TMessage> MergeFrom(byte[] data) {
      ((IBuilder) this).MergeFrom(data);
      return this;
    }

    public IBuilder<TMessage> MergeFrom(byte[] data, ExtensionRegistry extensionRegistry) {
      ((IBuilder) this).MergeFrom(data, extensionRegistry);
      return this;
    }

    public IBuilder<TMessage> MergeFrom(Stream input) {
      ((IBuilder) this).MergeFrom(input);
      return this;
    }

    public IBuilder<TMessage> MergeFrom(Stream input, ExtensionRegistry extensionRegistry) {
      ((IBuilder) this).MergeFrom(input, extensionRegistry);
      return this;
    }

    /// <summary>
    /// Like Build(), but will wrap UninitializedMessageException in
    /// InvalidProtocolBufferException.
    /// TODO(jonskeet): This used to be generated for each class. Find out why.
    /// </summary>
    public TMessage BuildParsed() {
      if (!Initialized) {
        throw new UninitializedMessageException(MessageBeingBuilt).AsInvalidProtocolBufferException();
      }
      return BuildPartial();
    }

    /// <summary>
    /// Implementation of <see cref="IBuilder{T}.Build" />.
    /// TODO(jonskeet): This used to be generated for each class. Find out why.
    /// </summary>
    public TMessage Build() {
      if (!Initialized) {
        throw new UninitializedMessageException(MessageBeingBuilt);
      }
      return BuildPartial();
    }
    
    public abstract TMessage BuildPartial();
    public abstract IBuilder<TMessage> Clone();
    public abstract new IBuilder<TMessage> Clear();
    public abstract TMessage DefaultInstanceForType { get; }
    public abstract IBuilder<TMessage> MergeFrom(CodedInputStream input);
    public abstract IBuilder<TMessage> MergeFrom(CodedInputStream input, ExtensionRegistry extensionRegistry);
  }
}