Skip to content

Commit e99951f

Browse files
author
rstam
committed
Minor renaming and doc comment fixes.
1 parent 1ad2875 commit e99951f

21 files changed

+78
-63
lines changed

‎Bson/IO/BsonReader.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,7 @@ public string FindStringElement(string name)
282282
/// <summary>
283283
/// Gets the current BsonType (calls ReadBsonType if necessary).
284284
/// </summary>
285+
/// <returns>The current BsonType.</returns>
285286
public BsonType GetCurrentBsonType()
286287
{
287288
if (_state == BsonReaderState.Initial || _state == BsonReaderState.Done || _state == BsonReaderState.ScopeDocument || _state == BsonReaderState.Type)

‎Bson/Serialization/BsonClassMapSerializer.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ public class BsonClassMapSerializer : IBsonSerializer
3939
/// <summary>
4040
/// Initializes a new instance of the BsonClassMapSerializer class.
4141
/// </summary>
42+
/// <param name="classMap">The class map.</param>
4243
public BsonClassMapSerializer(BsonClassMap classMap)
4344
{
4445
_classMap = classMap;
@@ -291,7 +292,7 @@ public void Serialize(
291292
if (documentSerializationOptions == null)
292293
{
293294
var message = string.Format(
294-
"Serialize method of BsonDocument expected serialization options of type {0}, not {1}.",
295+
"Serializer BsonClassMapSerializer expected serialization options of type {0}, not {1}.",
295296
BsonUtils.GetFriendlyTypeName(typeof(DocumentSerializationOptions)),
296297
BsonUtils.GetFriendlyTypeName(options.GetType()));
297298
throw new BsonSerializationException(message);

‎Bson/Serialization/Serializers/ArraySerializer.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ public override void Serialize(
133133
}
134134

135135
var array = (T[])value;
136-
var arraySerializationOptions = CastSerializationOptions<ArraySerializationOptions>(options);
136+
var arraySerializationOptions = EnsureSerializationOptions<ArraySerializationOptions>(options);
137137
var itemSerializationOptions = arraySerializationOptions.ItemSerializationOptions;
138138

139139
bsonWriter.WriteStartArray();
@@ -266,7 +266,7 @@ public override void Serialize(
266266
}
267267

268268
var array = (T[,])value;
269-
var arraySerializationOptions = CastSerializationOptions<ArraySerializationOptions>(options);
269+
var arraySerializationOptions = EnsureSerializationOptions<ArraySerializationOptions>(options);
270270
var itemSerializationOptions = arraySerializationOptions.ItemSerializationOptions;
271271

272272
bsonWriter.WriteStartArray();
@@ -423,7 +423,7 @@ public override void Serialize(
423423
}
424424

425425
var array = (T[, ,])value;
426-
var arraySerializationOptions = CastSerializationOptions<ArraySerializationOptions>(options);
426+
var arraySerializationOptions = EnsureSerializationOptions<ArraySerializationOptions>(options);
427427
var itemSerializationOptions = arraySerializationOptions.ItemSerializationOptions;
428428

429429
bsonWriter.WriteStartArray();

‎Bson/Serialization/Serializers/BsonBaseSerializer.cs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ protected BsonBaseSerializer()
4545
/// <summary>
4646
/// Initializes a new instance of the BsonBaseSerializer class.
4747
/// </summary>
48+
/// <param name="defaultSerializationOptions">The default serialization options for this serializer.</param>
4849
protected BsonBaseSerializer(IBsonSerializationOptions defaultSerializationOptions)
4950
{
5051
if (defaultSerializationOptions != null)
@@ -168,12 +169,12 @@ public virtual void SetDocumentId(object document, object id)
168169

169170
// protected methods
170171
/// <summary>
171-
/// Casts the provided serialization options (or the defaults if null) to the required type.
172+
/// Ensures that the serializer has serialization options of the right type (replacing null with the default serialization options if necessary).
172173
/// </summary>
173174
/// <typeparam name="TSerializationOptions">The required serialization options type.</typeparam>
174175
/// <param name="options">The serialization options.</param>
175176
/// <returns>The serialization options (or the defaults if null) cast to the required type.</returns>
176-
protected TSerializationOptions CastSerializationOptions<TSerializationOptions>(IBsonSerializationOptions options) where TSerializationOptions : class, IBsonSerializationOptions
177+
protected TSerializationOptions EnsureSerializationOptions<TSerializationOptions>(IBsonSerializationOptions options) where TSerializationOptions : class, IBsonSerializationOptions
177178
{
178179
if (options == null)
179180
{

‎Bson/Serialization/Serializers/BsonPrimitiveSerializers.cs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ public override void Serialize(
107107
IBsonSerializationOptions options)
108108
{
109109
var boolValue = (bool)value;
110-
var representationSerializationOptions = CastSerializationOptions<RepresentationSerializationOptions>(options);
110+
var representationSerializationOptions = EnsureSerializationOptions<RepresentationSerializationOptions>(options);
111111

112112
switch (representationSerializationOptions.Representation)
113113
{
@@ -175,7 +175,7 @@ public override object Deserialize(
175175
IBsonSerializationOptions options)
176176
{
177177
VerifyTypes(nominalType, actualType, typeof(DateTime));
178-
var dateTimeSerializationOptions = CastSerializationOptions<DateTimeSerializationOptions>(options);
178+
var dateTimeSerializationOptions = EnsureSerializationOptions<DateTimeSerializationOptions>(options);
179179

180180
var bsonType = bsonReader.GetCurrentBsonType();
181181
DateTime value;
@@ -250,7 +250,7 @@ public override void Serialize(
250250
IBsonSerializationOptions options)
251251
{
252252
var dateTime = (DateTime)value;
253-
var dateTimeSerializationOptions = CastSerializationOptions<DateTimeSerializationOptions>(options);
253+
var dateTimeSerializationOptions = EnsureSerializationOptions<DateTimeSerializationOptions>(options);
254254

255255
DateTime utcDateTime;
256256
if (dateTimeSerializationOptions.DateOnly)
@@ -351,7 +351,7 @@ public override object Deserialize(
351351
IBsonSerializationOptions options)
352352
{
353353
VerifyTypes(nominalType, actualType, typeof(double));
354-
var representationSerializationOptions = CastSerializationOptions<RepresentationSerializationOptions>(options);
354+
var representationSerializationOptions = EnsureSerializationOptions<RepresentationSerializationOptions>(options);
355355

356356
var bsonType = bsonReader.GetCurrentBsonType();
357357
switch (bsonType)
@@ -384,7 +384,7 @@ public override void Serialize(
384384
IBsonSerializationOptions options)
385385
{
386386
var doubleValue = (double)value;
387-
var representationSerializationOptions = CastSerializationOptions<RepresentationSerializationOptions>(options);
387+
var representationSerializationOptions = EnsureSerializationOptions<RepresentationSerializationOptions>(options);
388388

389389
switch (representationSerializationOptions.Representation)
390390
{
@@ -496,7 +496,7 @@ public override void Serialize(
496496
IBsonSerializationOptions options)
497497
{
498498
var guid = (Guid)value;
499-
var representationSerializationOptions = CastSerializationOptions<RepresentationSerializationOptions>(options);
499+
var representationSerializationOptions = EnsureSerializationOptions<RepresentationSerializationOptions>(options);
500500

501501
switch (representationSerializationOptions.Representation)
502502
{
@@ -562,7 +562,7 @@ public override object Deserialize(
562562
IBsonSerializationOptions options)
563563
{
564564
VerifyTypes(nominalType, actualType, typeof(int));
565-
var representationSerializationOptions = CastSerializationOptions<RepresentationSerializationOptions>(options);
565+
var representationSerializationOptions = EnsureSerializationOptions<RepresentationSerializationOptions>(options);
566566

567567
var bsonType = bsonReader.GetCurrentBsonType();
568568
switch (bsonType)
@@ -595,7 +595,7 @@ public override void Serialize(
595595
IBsonSerializationOptions options)
596596
{
597597
var int32Value = (int)value;
598-
var representationSerializationOptions = CastSerializationOptions<RepresentationSerializationOptions>(options);
598+
var representationSerializationOptions = EnsureSerializationOptions<RepresentationSerializationOptions>(options);
599599

600600
switch (representationSerializationOptions.Representation)
601601
{
@@ -660,7 +660,7 @@ public override object Deserialize(
660660
IBsonSerializationOptions options)
661661
{
662662
VerifyTypes(nominalType, actualType, typeof(long));
663-
var representationSerializationOptions = CastSerializationOptions<RepresentationSerializationOptions>(options);
663+
var representationSerializationOptions = EnsureSerializationOptions<RepresentationSerializationOptions>(options);
664664

665665
var bsonType = bsonReader.GetCurrentBsonType();
666666
switch (bsonType)
@@ -693,7 +693,7 @@ public override void Serialize(
693693
IBsonSerializationOptions options)
694694
{
695695
var int64Value = (long)value;
696-
var representationSerializationOptions = CastSerializationOptions<RepresentationSerializationOptions>(options);
696+
var representationSerializationOptions = EnsureSerializationOptions<RepresentationSerializationOptions>(options);
697697

698698
switch (representationSerializationOptions.Representation)
699699
{

‎Bson/Serialization/Serializers/BsonValueSerializers.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@ public override object Deserialize(
348348
}
349349
else
350350
{
351-
var dateTimeSerializationOptions = CastSerializationOptions<DateTimeSerializationOptions>(options);
351+
var dateTimeSerializationOptions = EnsureSerializationOptions<DateTimeSerializationOptions>(options);
352352

353353
long? millisecondsSinceEpoch = null;
354354
long? ticks = null;
@@ -459,7 +459,7 @@ public override void Serialize(
459459
else
460460
{
461461
var bsonDateTime = (BsonDateTime)value;
462-
var dateTimeSerializationOptions = CastSerializationOptions<DateTimeSerializationOptions>(options);
462+
var dateTimeSerializationOptions = EnsureSerializationOptions<DateTimeSerializationOptions>(options);
463463

464464
DateTime utcDateTime = DateTime.MinValue;
465465
long millisecondsSinceEpoch;
@@ -1673,7 +1673,7 @@ public override void Serialize(
16731673
else
16741674
{
16751675
var symbol = (BsonSymbol)value;
1676-
var representationSerializationOptions = CastSerializationOptions<RepresentationSerializationOptions>(options);
1676+
var representationSerializationOptions = EnsureSerializationOptions<RepresentationSerializationOptions>(options);
16771677

16781678
switch (representationSerializationOptions.Representation)
16791679
{

‎Bson/Serialization/Serializers/DictionaryGenericSerializer.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ public override void Serialize(
228228
}
229229

230230
var dictionary = (IDictionary<TKey, TValue>)value;
231-
var dictionarySerializationOptions = CastSerializationOptions<DictionarySerializationOptions>(options);
231+
var dictionarySerializationOptions = EnsureSerializationOptions<DictionarySerializationOptions>(options);
232232
var representation = dictionarySerializationOptions.Representation;
233233
var itemSerializationOptions = dictionarySerializationOptions.ItemSerializationOptions;
234234

‎Bson/Serialization/Serializers/DictionarySerializer.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ public override void Serialize(
238238
}
239239

240240
var dictionary = (IDictionary)value;
241-
var dictionarySerializationOptions = CastSerializationOptions<DictionarySerializationOptions>(options);
241+
var dictionarySerializationOptions = EnsureSerializationOptions<DictionarySerializationOptions>(options);
242242
var representation = dictionarySerializationOptions.Representation;
243243
var itemSerializationOptions = dictionarySerializationOptions.ItemSerializationOptions;
244244

‎Bson/Serialization/Serializers/EnumSerializer.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public class EnumSerializer : BsonBaseSerializer
3939
/// Initializes a new instance of the EnumSerializer class.
4040
/// </summary>
4141
public EnumSerializer()
42-
: base(new RepresentationSerializationOptions((BsonType)0))
42+
: base(new RepresentationSerializationOptions((BsonType)0)) // 0 means use underlying type
4343
{
4444
}
4545

@@ -94,7 +94,7 @@ public override void Serialize(
9494
var actualType = value.GetType();
9595
VerifySerializeTypes(nominalType, actualType);
9696

97-
var representationSerializationOptions = CastSerializationOptions<RepresentationSerializationOptions>(options);
97+
var representationSerializationOptions = EnsureSerializationOptions<RepresentationSerializationOptions>(options);
9898

9999
switch (representationSerializationOptions.Representation)
100100
{

0 commit comments

Comments
 (0)