-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
SerializerBase.cs
127 lines (117 loc) · 4.74 KB
/
SerializerBase.cs
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
/* Copyright 2010-present MongoDB Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System;
using MongoDB.Bson.IO;
using MongoDB.Bson.Serialization.Conventions;
namespace MongoDB.Bson.Serialization.Serializers
{
/// <summary>
/// Represents an abstract base class for serializers.
/// </summary>
/// <typeparam name="TValue">The type of the value.</typeparam>
public abstract class SerializerBase<TValue> : IBsonSerializer<TValue>
{
// public properties
/// <summary>
/// Gets the type of the values.
/// </summary>
/// <value>
/// The type of the values.
/// </value>
public Type ValueType
{
get { return typeof(TValue); }
}
// public methods
/// <summary>
/// Deserializes a value.
/// </summary>
/// <param name="context">The deserialization context.</param>
/// <param name="args">The deserialization args.</param>
/// <returns>A deserialized value.</returns>
public virtual TValue Deserialize(BsonDeserializationContext context, BsonDeserializationArgs args)
{
throw CreateCannotBeDeserializedException();
}
/// <summary>
/// Serializes a value.
/// </summary>
/// <param name="context">The serialization context.</param>
/// <param name="args">The serialization args.</param>
/// <param name="value">The value.</param>
public virtual void Serialize(BsonSerializationContext context, BsonSerializationArgs args, TValue value)
{
throw CreateCannotBeSerializedException();
}
// protected methods
/// <summary>
/// Creates an exception to throw when a type cannot be deserialized.
/// </summary>
/// <returns>An exception.</returns>
protected Exception CreateCannotBeDeserializedException()
{
var message = string.Format(
"Values of type '{0}' cannot be deserialized using a serializer of type '{1}'.",
BsonUtils.GetFriendlyTypeName(typeof(TValue)),
BsonUtils.GetFriendlyTypeName(GetType()));
return new NotSupportedException(message);
}
/// <summary>
/// Creates an exception to throw when a type cannot be deserialized.
/// </summary>
/// <returns>An exception.</returns>
protected Exception CreateCannotBeSerializedException()
{
var message = string.Format(
"Values of type '{0}' cannot be serialized using a serializer of type '{1}'.",
BsonUtils.GetFriendlyTypeName(typeof(TValue)),
BsonUtils.GetFriendlyTypeName(GetType()));
return new NotSupportedException(message);
}
/// <summary>
/// Creates an exception to throw when a type cannot be deserialized from a BsonType.
/// </summary>
/// <param name="bsonType">The BSON type.</param>
/// <returns>An exception.</returns>
protected Exception CreateCannotDeserializeFromBsonTypeException(BsonType bsonType)
{
var message = string.Format("Cannot deserialize a '{0}' from BsonType '{1}'.",
BsonUtils.GetFriendlyTypeName(ValueType),
bsonType);
return new FormatException(message);
}
/// <summary>
/// Ensures that the BsonType equals the expected type.
/// </summary>
/// <param name="reader">The reader.</param>
/// <param name="bsonType">The expected type.</param>
protected void EnsureBsonTypeEquals(IBsonReader reader, BsonType bsonType)
{
if (reader.GetCurrentBsonType() != bsonType)
{
throw CreateCannotDeserializeFromBsonTypeException(reader.GetCurrentBsonType());
}
}
// explicit interface implementations
object IBsonSerializer.Deserialize(BsonDeserializationContext context, BsonDeserializationArgs args)
{
return Deserialize(context, args);
}
void IBsonSerializer.Serialize(BsonSerializationContext context, BsonSerializationArgs args, object value)
{
Serialize(context, args, (TValue)value);
}
}
}