Add API to configure ValueConverter and ValueComparer types

Part of #1906

src/EFCore/ChangeTracking/Internal/ValueComparerExtensions.cs

@@ -51,9 +51,7 @@ public static ValueComparer ToNonNullNullableComparer(this ValueComparer compare
 
         private sealed class NonNullNullableValueComparer<T> : ValueComparer<T>
         {
-#pragma warning disable CA1061 // Do not hide base class methods
             public NonNullNullableValueComparer(
-#pragma warning restore CA1061 // Do not hide base class methods
                 LambdaExpression equalsExpression,
                 LambdaExpression hashCodeExpression,
                 LambdaExpression snapshotExpression)

src/EFCore/Metadata/Builders/IConventionPropertyBuilder.cs

@@ -393,6 +393,35 @@ bool CanSetValueGeneratorFactory(
         /// </returns>
         bool CanSetConversion(Type? providerClrType, bool fromDataAnnotation = false);
 
+        /// <summary>
+        ///     Configures the property so that the property value is converted to and from the database
+        ///     using the given <see cref="ValueConverter" />.
+        /// </summary>
+        /// <param name="converterType">
+        ///     A type that derives from <see cref="ValueConverter"/>,
+        ///     or <see langword="null" /> to remove any previously set converter.
+        /// </param>
+        /// <param name="fromDataAnnotation"> Indicates whether the configuration was specified using a data annotation. </param>
+        /// <returns>
+        ///     The same builder instance if the configuration was applied,
+        ///     <see langword="null" /> otherwise.
+        /// </returns>
+        IConventionPropertyBuilder? HasConverter(Type? converterType, bool fromDataAnnotation = false);
+
+        /// <summary>
+        ///     Returns a value indicating whether the <see cref="ValueConverter" /> can be configured for this property
+        ///     from the current configuration source.
+        /// </summary>
+        /// <param name="converterType">
+        ///     A type that derives from <see cref="ValueConverter"/>,
+        ///     or <see langword="null" /> to remove any previously set converter.
+        /// </param>
+        /// <param name="fromDataAnnotation"> Indicates whether the configuration was specified using a data annotation. </param>
+        /// <returns>
+        ///     <see langword="true" /> if the <see cref="ValueConverter" /> can be configured for this property.
+        /// </returns>
+        bool CanSetConverter(Type? converterType, bool fromDataAnnotation = false);
+
         /// <summary>
         ///     Configures the <see cref="CoreTypeMapping" /> for this property.
         /// </summary>
@@ -421,8 +450,7 @@ bool CanSetValueGeneratorFactory(
         /// <param name="comparer"> The comparer, or <see langword="null" /> to remove any previously set comparer. </param>
         /// <param name="fromDataAnnotation"> Indicates whether the configuration was specified using a data annotation. </param>
         /// <returns>
-        ///     The same builder instance if the configuration was applied,
-        ///     <see langword="null" /> otherwise.
+        ///     The same builder instance if the configuration was applied, <see langword="null" /> otherwise.
         /// </returns>
         IConventionPropertyBuilder? HasValueComparer(ValueComparer? comparer, bool fromDataAnnotation = false);
 
@@ -437,6 +465,33 @@ bool CanSetValueGeneratorFactory(
         /// </returns>
         bool CanSetValueComparer(ValueComparer? comparer, bool fromDataAnnotation = false);
 
+        /// <summary>
+        ///     Configures the <see cref="ValueComparer" /> for this property.
+        /// </summary>
+        /// <param name="comparerType">
+        ///     A type that derives from <see cref="ValueComparer"/>,
+        ///     or <see langword="null" /> to remove any previously set comparer.
+        /// </param>
+        /// <param name="fromDataAnnotation"> Indicates whether the configuration was specified using a data annotation. </param>
+        /// <returns>
+        ///     The same builder instance if the configuration was applied, <see langword="null" /> otherwise.
+        /// </returns>
+        IConventionPropertyBuilder? HasValueComparer(Type? comparerType, bool fromDataAnnotation = false);
+
+        /// <summary>
+        ///     Returns a value indicating whether the given <see cref="ValueComparer" />
+        ///     can be configured for this property from the current configuration source.
+        /// </summary>
+        /// <param name="comparerType">
+        ///     A type that derives from <see cref="ValueComparer"/>,
+        ///     or <see langword="null" /> to remove any previously set comparer.
+        /// </param>
+        /// <param name="fromDataAnnotation"> Indicates whether the configuration was specified using a data annotation. </param>
+        /// <returns>
+        ///     <see langword="true" /> if the given <see cref="ValueComparer" /> can be configured for this property.
+        /// </returns>
+        bool CanSetValueComparer(Type? comparerType, bool fromDataAnnotation = false);
+
         /// <summary>
         ///     Configures the <see cref="ValueComparer" /> to be used for key comparisons for this property.
         /// </summary>

src/EFCore/Metadata/Builders/PropertyBuilder.cs

@@ -514,6 +514,33 @@ public virtual PropertyBuilder HasConversion(ValueConverter? converter, ValueCom
             return this;
         }
 
+        /// <summary>
+        ///     Configures the property so that the property value is converted to and from the database
+        ///     using the given <see cref="ValueConverter" />.
+        /// </summary>
+        /// <typeparam name="TConverter"> A type that derives from <see cref="ValueConverter"/>. </typeparam>
+        /// <typeparam name="TComparer"> A type that derives from <see cref="ValueComparer"/>. </typeparam>
+        /// <returns> The same builder instance so that multiple configuration calls can be chained. </returns>
+        public virtual PropertyBuilder HasConversion<TConverter, TComparer>()
+            where TConverter : ValueConverter
+            where TComparer : ValueComparer
+            => HasConversion(typeof(TConverter), typeof(TComparer));
+
+        /// <summary>
+        ///     Configures the property so that the property value is converted to and from the database
+        ///     using the given <see cref="ValueConverter" />.
+        /// </summary>
+        /// <param name="converterType"> A type that derives from <see cref="ValueConverter"/>. </param>
+        /// <param name="comparerType"> A type that derives from <see cref="ValueComparer"/>. </param>
+        /// <returns> The same builder instance so that multiple configuration calls can be chained. </returns>
+        public virtual PropertyBuilder HasConversion(Type? converterType, Type? comparerType)
+        {
+            Builder.HasConverter(converterType, ConfigurationSource.Explicit);
+            Builder.HasValueComparer(comparerType, ConfigurationSource.Explicit);
+
+            return this;
+        }
+
         #region Hidden System.Object members
 
         /// <summary>

src/EFCore/Metadata/Builders/PropertyBuilder`.cs

@@ -319,6 +319,26 @@ public PropertyBuilder(IMutableProperty property)
         public new virtual PropertyBuilder<TProperty> HasField(string fieldName)
             => (PropertyBuilder<TProperty>)base.HasField(fieldName);
 
+        /// <summary>
+        ///     <para>
+        ///         Sets the <see cref="PropertyAccessMode" /> to use for this property.
+        ///     </para>
+        ///     <para>
+        ///         By default, the backing field, if one is found by convention or has been specified, is used when
+        ///         new objects are constructed, typically when entities are queried from the database.
+        ///         Properties are used for all other accesses.  Calling this method will change that behavior
+        ///         for this property as described in the <see cref="PropertyAccessMode" /> enum.
+        ///     </para>
+        ///     <para>
+        ///         Calling this method overrides for this property any access mode that was set on the
+        ///         entity type or model.
+        ///     </para>
+        /// </summary>
+        /// <param name="propertyAccessMode"> The <see cref="PropertyAccessMode" /> to use for this property. </param>
+        /// <returns> The same builder instance so that multiple configuration calls can be chained. </returns>
+        public new virtual PropertyBuilder<TProperty> UsePropertyAccessMode(PropertyAccessMode propertyAccessMode)
+            => (PropertyBuilder<TProperty>)base.UsePropertyAccessMode(propertyAccessMode);
+
         /// <summary>
         ///     Configures the property so that the property value is converted to the given type before
         ///     writing to the database and converted back when reading from the database.
@@ -439,23 +459,25 @@ public virtual PropertyBuilder<TProperty> HasConversion<TProvider>(
             => (PropertyBuilder<TProperty>)base.HasConversion(converter, valueComparer);
 
         /// <summary>
-        ///     <para>
-        ///         Sets the <see cref="PropertyAccessMode" /> to use for this property.
-        ///     </para>
-        ///     <para>
-        ///         By default, the backing field, if one is found by convention or has been specified, is used when
-        ///         new objects are constructed, typically when entities are queried from the database.
-        ///         Properties are used for all other accesses.  Calling this method will change that behavior
-        ///         for this property as described in the <see cref="PropertyAccessMode" /> enum.
-        ///     </para>
-        ///     <para>
-        ///         Calling this method overrides for this property any access mode that was set on the
-        ///         entity type or model.
-        ///     </para>
+        ///     Configures the property so that the property value is converted to and from the database
+        ///     using the given <see cref="ValueConverter" />.
         /// </summary>
-        /// <param name="propertyAccessMode"> The <see cref="PropertyAccessMode" /> to use for this property. </param>
+        /// <typeparam name="TConverter"> A type that derives from <see cref="ValueConverter"/>. </typeparam>
+        /// <typeparam name="TComparer"> A type that derives from <see cref="ValueComparer"/>. </typeparam>
         /// <returns> The same builder instance so that multiple configuration calls can be chained. </returns>
-        public new virtual PropertyBuilder<TProperty> UsePropertyAccessMode(PropertyAccessMode propertyAccessMode)
-            => (PropertyBuilder<TProperty>)base.UsePropertyAccessMode(propertyAccessMode);
+        public new virtual PropertyBuilder<TProperty> HasConversion<TConverter, TComparer>()
+            where TConverter : ValueConverter
+            where TComparer : ValueComparer
+            => (PropertyBuilder<TProperty>)base.HasConversion<TConverter, TComparer>();
+
+        /// <summary>
+        ///     Configures the property so that the property value is converted to and from the database
+        ///     using the given <see cref="ValueConverter" />.
+        /// </summary>
+        /// <param name="converterType"> A type that derives from <see cref="ValueConverter"/>. </param>
+        /// <param name="comparerType"> A type that derives from <see cref="ValueComparer"/>. </param>
+        /// <returns> The same builder instance so that multiple configuration calls can be chained. </returns>
+        public new virtual PropertyBuilder<TProperty> HasConversion(Type? converterType, Type? comparerType)
+            => (PropertyBuilder<TProperty>)base.HasConversion(converterType, comparerType);
     }
 }

src/EFCore/Metadata/Conventions/SlimModelConvention.cs

@@ -308,8 +308,12 @@ protected virtual void ProcessPropertyAnnotations(
                 annotations.Remove(CoreAnnotationNames.Precision);
                 annotations.Remove(CoreAnnotationNames.Scale);
                 annotations.Remove(CoreAnnotationNames.ProviderClrType);
+                annotations.Remove(CoreAnnotationNames.ValueGeneratorFactory);
+                annotations.Remove(CoreAnnotationNames.ValueGeneratorFactoryType);
                 annotations.Remove(CoreAnnotationNames.ValueConverter);
+                annotations.Remove(CoreAnnotationNames.ValueConverterType);
                 annotations.Remove(CoreAnnotationNames.ValueComparer);
+                annotations.Remove(CoreAnnotationNames.ValueComparerType);
             }
         }
 

src/EFCore/Metadata/IConventionProperty.cs

@@ -342,7 +342,17 @@ bool IsImplicitlyCreated()
         /// <param name="converter"> The converter, or <see langword="null" /> to remove any previously set converter. </param>
         /// <param name="fromDataAnnotation"> Indicates whether the configuration was specified using a data annotation. </param>
         /// <returns> The configured value. </returns>
-        ValueConverter? SetValueConverter(ValueConverter? converter,  bool fromDataAnnotation = false);
+        ValueConverter? SetValueConverter(ValueConverter? converter, bool fromDataAnnotation = false);
+
+        /// <summary>
+        ///     Sets the custom <see cref="ValueConverter" /> for this property.
+        /// </summary>
+        /// <param name="converterType">
+        ///     A type that derives from <see cref="ValueConverter"/>, or <see langword="null" /> to remove any previously set converter.
+        /// </param>
+        /// <param name="fromDataAnnotation"> Indicates whether the configuration was specified using a data annotation. </param>
+        /// <returns> The configured value. </returns>
+        Type? SetValueConverter(Type? converterType, bool fromDataAnnotation = false);
 
         /// <summary>
         ///     Returns the configuration source for <see cref="IReadOnlyProperty.GetValueConverter" />.
@@ -372,6 +382,16 @@ bool IsImplicitlyCreated()
         /// <returns> The configured value. </returns>
         ValueComparer? SetValueComparer(ValueComparer? comparer, bool fromDataAnnotation = false);
 
+        /// <summary>
+        ///     Sets the custom <see cref="ValueComparer" /> for this property.
+        /// </summary>
+        /// <param name="comparerType">
+        ///     A type that derives from <see cref="ValueComparer"/>, or <see langword="null" /> to remove any previously set comparer.
+        /// </param>
+        /// <param name="fromDataAnnotation"> Indicates whether the configuration was specified using a data annotation. </param>
+        /// <returns> The configured value. </returns>
+        Type? SetValueComparer(Type? comparerType, bool fromDataAnnotation = false);
+
         /// <summary>
         ///     Returns the configuration source for <see cref="IReadOnlyProperty.GetValueComparer" />.
         /// </summary>

src/EFCore/Metadata/IMutableProperty.cs

@@ -210,6 +210,14 @@ public interface IMutableProperty : IReadOnlyProperty, IMutablePropertyBase
         /// <param name="converter"> The converter, or <see langword="null" /> to remove any previously set converter. </param>
         void SetValueConverter(ValueConverter? converter);
 
+        /// <summary>
+        ///     Sets the custom <see cref="ValueConverter" /> for this property.
+        /// </summary>
+        /// <param name="converterType">
+        ///     A type that derives from <see cref="ValueConverter"/>, or <see langword="null" /> to remove any previously set converter.
+        /// </param>
+        void SetValueConverter(Type? converterType);
+
         /// <summary>
         ///     Sets the type that the property value will be converted to before being sent to the database provider.
         /// </summary>
@@ -227,5 +235,13 @@ public interface IMutableProperty : IReadOnlyProperty, IMutablePropertyBase
         /// </summary>
         /// <param name="comparer"> The comparer, or <see langword="null" /> to remove any previously set comparer. </param>
         void SetValueComparer(ValueComparer? comparer);
+
+        /// <summary>
+        ///     Sets the custom <see cref="ValueComparer" /> for this property.
+        /// </summary>
+        /// <param name="comparerType">
+        ///     A type that derives from <see cref="ValueComparer"/>, or <see langword="null" /> to remove any previously set comparer.
+        /// </param>
+        void SetValueComparer(Type? comparerType);
     }
 }

src/EFCore/Metadata/Internal/CoreAnnotationNames.cs

@@ -126,6 +126,14 @@ public static class CoreAnnotationNames
         /// </summary>
         public const string ValueConverter = "ValueConverter";
 
+        /// <summary>
+        ///     This is an internal API that supports the Entity Framework Core infrastructure and not subject to
+        ///     the same compatibility standards as public APIs. It may be changed or removed without notice in
+        ///     any release. You should only use it directly in your code with extreme caution and knowing that
+        ///     doing so can result in application failures when updating to a new Entity Framework Core release.
+        /// </summary>
+        public const string ValueConverterType = "ValueConverterType";
+
         /// <summary>
         ///     This is an internal API that supports the Entity Framework Core infrastructure and not subject to
         ///     the same compatibility standards as public APIs. It may be changed or removed without notice in
@@ -134,6 +142,14 @@ public static class CoreAnnotationNames
         /// </summary>
         public const string ValueComparer = "ValueComparer";
 
+        /// <summary>
+        ///     This is an internal API that supports the Entity Framework Core infrastructure and not subject to
+        ///     the same compatibility standards as public APIs. It may be changed or removed without notice in
+        ///     any release. You should only use it directly in your code with extreme caution and knowing that
+        ///     doing so can result in application failures when updating to a new Entity Framework Core release.
+        /// </summary>
+        public const string ValueComparerType = "ValueComparerType";
+
         /// <summary>
         ///     This is an internal API that supports the Entity Framework Core infrastructure and not subject to
         ///     the same compatibility standards as public APIs. It may be changed or removed without notice in
@@ -295,7 +311,9 @@ public static class CoreAnnotationNames
             DiscriminatorMappingComplete,
             DiscriminatorValue,
             ValueConverter,
+            ValueConverterType,
             ValueComparer,
+            ValueComparerType,
 #pragma warning disable 618
             KeyValueComparer,
             StructuralValueComparer,