/* 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 System.Reflection;
using MongoDB.Bson.Serialization.Options;
namespace MongoDB.Bson.Serialization.Conventions
{
///
/// A convention that allows you to set the Enum serialization representation
///
public class EnumRepresentationConvention : ConventionBase, IMemberMapConvention
{
// private fields
private readonly BsonType _representation;
// constructors
///
/// Initializes a new instance of the class.
///
/// The serialization representation. 0 is used to detect representation
/// from the enum itself.
public EnumRepresentationConvention(BsonType representation)
{
EnsureRepresentationIsValidForEnums(representation);
_representation = representation;
}
///
/// Gets the representation.
///
public BsonType Representation => _representation;
///
/// Applies a modification to the member map.
///
/// The member map.
public void Apply(BsonMemberMap memberMap)
{
var memberType = memberMap.MemberType;
var memberTypeInfo = memberType.GetTypeInfo();
if (memberTypeInfo.IsEnum)
{
var serializer = memberMap.GetSerializer();
var representationConfigurableSerializer = serializer as IRepresentationConfigurable;
if (representationConfigurableSerializer != null)
{
var reconfiguredSerializer = representationConfigurableSerializer.WithRepresentation(_representation);
memberMap.SetSerializer(reconfiguredSerializer);
}
return;
}
if (IsNullableEnum(memberType))
{
var serializer = memberMap.GetSerializer();
var childSerializerConfigurableSerializer = serializer as IChildSerializerConfigurable;
if (childSerializerConfigurableSerializer != null)
{
var childSerializer = childSerializerConfigurableSerializer.ChildSerializer;
var representationConfigurableChildSerializer = childSerializer as IRepresentationConfigurable;
if (representationConfigurableChildSerializer != null)
{
var reconfiguredChildSerializer = representationConfigurableChildSerializer.WithRepresentation(_representation);
var reconfiguredSerializer = childSerializerConfigurableSerializer.WithChildSerializer(reconfiguredChildSerializer);
memberMap.SetSerializer(reconfiguredSerializer);
}
}
return;
}
}
// private methods
private bool IsNullableEnum(Type type)
{
return
type.GetTypeInfo().IsGenericType &&
type.GetGenericTypeDefinition() == typeof(Nullable<>) &&
Nullable.GetUnderlyingType(type).GetTypeInfo().IsEnum;
}
private void EnsureRepresentationIsValidForEnums(BsonType representation)
{
if (
representation == 0 ||
representation == BsonType.String ||
representation == BsonType.Int32 ||
representation == BsonType.Int64)
{
return;
}
throw new ArgumentException("Enums can only be represented as String, Int32, Int64 or the type of the enum", "representation");
}
}
}