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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
#region Copyright notice and license
// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc. All rights reserved.
// http://github.com/jskeet/dotnet-protobufs/
// Original C++/Java/Python code:
// 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.
#endregion
using System;
using System.Collections;
using System.Collections.Generic;
using System.Text;
#if !LITE
using Google.ProtocolBuffers.Collections;
using Google.ProtocolBuffers.Descriptors;
#endif
namespace Google.ProtocolBuffers
{
/// <summary>
/// TODO(jonskeet): Write summary text.
/// </summary>
public sealed class UninitializedMessageException : Exception
{
private readonly IList<string> missingFields;
private UninitializedMessageException(IList<string> missingFields)
: base(BuildDescription(missingFields))
{
this.missingFields = new List<string>(missingFields);
}
/// <summary>
/// Returns a read-only list of human-readable names of
/// required fields missing from this message. Each name
/// is a full path to a field, e.g. "foo.bar[5].baz"
/// </summary>
public IList<string> MissingFields
{
get { return missingFields; }
}
/// <summary>
/// Converts this exception into an InvalidProtocolBufferException.
/// When a parsed message is missing required fields, this should be thrown
/// instead of UninitializedMessageException.
/// </summary>
public InvalidProtocolBufferException AsInvalidProtocolBufferException()
{
return new InvalidProtocolBufferException(Message);
}
/// <summary>
/// Constructs the description string for a given list of missing fields.
/// </summary>
private static string BuildDescription(IEnumerable<string> missingFields)
{
StringBuilder description = new StringBuilder("Message missing required fields: ");
bool first = true;
foreach (string field in missingFields)
{
if (first)
{
first = false;
}
else
{
description.Append(", ");
}
description.Append(field);
}
return description.ToString();
}
/// <summary>
/// For Lite exceptions that do not known how to enumerate missing fields
/// </summary>
public UninitializedMessageException(IMessageLite message)
: base(String.Format("Message {0} is missing required fields", message.GetType()))
{
missingFields = new List<string>();
}
#if !LITE
public UninitializedMessageException(IMessage message)
: this(FindMissingFields(message))
{
}
/// <summary>
/// Returns a list of the full "paths" of missing required
/// fields in the specified message.
/// </summary>
private static IList<String> FindMissingFields(IMessage message)
{
List<String> results = new List<String>();
FindMissingFields(message, "", results);
return results;
}
/// <summary>
/// Recursive helper implementing FindMissingFields.
/// </summary>
private static void FindMissingFields(IMessage message, String prefix, List<String> results)
{
foreach (FieldDescriptor field in message.DescriptorForType.Fields)
{
if (field.IsRequired && !message.HasField(field))
{
results.Add(prefix + field.Name);
}
}
foreach (KeyValuePair<FieldDescriptor, object> entry in message.AllFields)
{
FieldDescriptor field = entry.Key;
object value = entry.Value;
if (field.MappedType == MappedType.Message)
{
if (field.IsRepeated)
{
int i = 0;
foreach (object element in (IEnumerable) value)
{
if (element is IMessage)
{
FindMissingFields((IMessage) element, SubMessagePrefix(prefix, field, i++), results);
}
else
{
results.Add(prefix + field.Name);
}
}
}
else
{
if (message.HasField(field))
{
if (value is IMessage)
{
FindMissingFields((IMessage) value, SubMessagePrefix(prefix, field, -1), results);
}
else
{
results.Add(prefix + field.Name);
}
}
}
}
}
}
private static String SubMessagePrefix(String prefix, FieldDescriptor field, int index)
{
StringBuilder result = new StringBuilder(prefix);
if (field.IsExtension)
{
result.Append('(')
.Append(field.FullName)
.Append(')');
}
else
{
result.Append(field.Name);
}
if (index != -1)
{
result.Append('[')
.Append(index)
.Append(']');
}
result.Append('.');
return result.ToString();
}
#endif
}
}
|
