DefaultModelBindingMessageProvider.cs

// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

using System;
using Microsoft.AspNetCore.Mvc.Core;

namespace Microsoft.AspNetCore.Mvc.ModelBinding.Metadata
{
    /// <summary>
    /// Read / write <see cref="ModelBindingMessageProvider"/> implementation.
    /// </summary>
    public class DefaultModelBindingMessageProvider : ModelBindingMessageProvider
    {
        private Func<string, string> _missingBindRequiredValueAccessor;
        private Func<string> _missingKeyOrValueAccessor;
        private Func<string> _missingRequestBodyRequiredValueAccessor;
        private Func<string, string> _valueMustNotBeNullAccessor;
        private Func<string, string, string> _attemptedValueIsInvalidAccessor;
        private Func<string, string> _nonPropertyAttemptedValueIsInvalidAccessor;
        private Func<string, string> _unknownValueIsInvalidAccessor;
        private Func<string> _nonPropertyUnknownValueIsInvalidAccessor;
        private Func<string, string> _valueIsInvalidAccessor;
        private Func<string, string> _valueMustBeANumberAccessor;
        private Func<string> _nonPropertyValueMustBeANumberAccessor;

        /// <summary>
        /// Initializes a new instance of the <see cref="DefaultModelBindingMessageProvider"/> class.
        /// </summary>
        public DefaultModelBindingMessageProvider()
        {
            SetMissingBindRequiredValueAccessor(Resources.FormatModelBinding_MissingBindRequiredMember);
            SetMissingKeyOrValueAccessor(Resources.FormatKeyValuePair_BothKeyAndValueMustBePresent);
            SetMissingRequestBodyRequiredValueAccessor(Resources.FormatModelBinding_MissingRequestBodyRequiredMember);
            SetValueMustNotBeNullAccessor(Resources.FormatModelBinding_NullValueNotValid);
            SetAttemptedValueIsInvalidAccessor(Resources.FormatModelState_AttemptedValueIsInvalid);
            SetNonPropertyAttemptedValueIsInvalidAccessor(Resources.FormatModelState_NonPropertyAttemptedValueIsInvalid);
            SetUnknownValueIsInvalidAccessor(Resources.FormatModelState_UnknownValueIsInvalid);
            SetNonPropertyUnknownValueIsInvalidAccessor(Resources.FormatModelState_NonPropertyUnknownValueIsInvalid);
            SetValueIsInvalidAccessor(Resources.FormatHtmlGeneration_ValueIsInvalid);
            SetValueMustBeANumberAccessor(Resources.FormatHtmlGeneration_ValueMustBeNumber);
            SetNonPropertyValueMustBeANumberAccessor(Resources.FormatHtmlGeneration_NonPropertyValueMustBeNumber);
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="DefaultModelBindingMessageProvider"/> class based on
        /// <paramref name="originalProvider"/>.
        /// </summary>
        /// <param name="originalProvider">The <see cref="DefaultModelBindingMessageProvider"/> to duplicate.</param>
        public DefaultModelBindingMessageProvider(DefaultModelBindingMessageProvider originalProvider)
        {
            if (originalProvider == null)
            {
                throw new ArgumentNullException(nameof(originalProvider));
            }

            SetMissingBindRequiredValueAccessor(originalProvider.MissingBindRequiredValueAccessor);
            SetMissingKeyOrValueAccessor(originalProvider.MissingKeyOrValueAccessor);
            SetMissingRequestBodyRequiredValueAccessor(originalProvider.MissingRequestBodyRequiredValueAccessor);
            SetValueMustNotBeNullAccessor(originalProvider.ValueMustNotBeNullAccessor);
            SetAttemptedValueIsInvalidAccessor(originalProvider.AttemptedValueIsInvalidAccessor);
            SetNonPropertyAttemptedValueIsInvalidAccessor(originalProvider.NonPropertyAttemptedValueIsInvalidAccessor);
            SetUnknownValueIsInvalidAccessor(originalProvider.UnknownValueIsInvalidAccessor);
            SetNonPropertyUnknownValueIsInvalidAccessor(originalProvider.NonPropertyUnknownValueIsInvalidAccessor);
            SetValueIsInvalidAccessor(originalProvider.ValueIsInvalidAccessor);
            SetValueMustBeANumberAccessor(originalProvider.ValueMustBeANumberAccessor);
            SetNonPropertyValueMustBeANumberAccessor(originalProvider.NonPropertyValueMustBeANumberAccessor);
        }

        /// <inheritdoc/>
        public override Func<string, string> MissingBindRequiredValueAccessor => _missingBindRequiredValueAccessor;

        /// <summary>
        /// Sets the <see cref="MissingBindRequiredValueAccessor"/> property.
        /// </summary>
        /// <param name="missingBindRequiredValueAccessor">The value to set.</param>
        public void SetMissingBindRequiredValueAccessor(Func<string, string> missingBindRequiredValueAccessor)
        {
            if (missingBindRequiredValueAccessor == null)
            {
                throw new ArgumentNullException(nameof(missingBindRequiredValueAccessor));
            }

            _missingBindRequiredValueAccessor = missingBindRequiredValueAccessor;
        }

        /// <inheritdoc/>
        public override Func<string> MissingKeyOrValueAccessor => _missingKeyOrValueAccessor;

        /// <summary>
        /// Sets the <see cref="MissingKeyOrValueAccessor"/> property.
        /// </summary>
        /// <param name="missingKeyOrValueAccessor">The value to set.</param>
        public void SetMissingKeyOrValueAccessor(Func<string> missingKeyOrValueAccessor)
        {
            if (missingKeyOrValueAccessor == null)
            {
                throw new ArgumentNullException(nameof(missingKeyOrValueAccessor));
            }

            _missingKeyOrValueAccessor = missingKeyOrValueAccessor;
        }

        /// <inheritdoc/>
        public override Func<string> MissingRequestBodyRequiredValueAccessor => _missingRequestBodyRequiredValueAccessor;

        /// <summary>
        /// Sets the <see cref="MissingRequestBodyRequiredValueAccessor"/> property.
        /// </summary>
        /// <param name="missingRequestBodyRequiredValueAccessor">The value to set.</param>
        public void SetMissingRequestBodyRequiredValueAccessor(Func<string> missingRequestBodyRequiredValueAccessor)
        {
            if (missingRequestBodyRequiredValueAccessor == null)
            {
                throw new ArgumentNullException(nameof(missingRequestBodyRequiredValueAccessor));
            }

            _missingRequestBodyRequiredValueAccessor = missingRequestBodyRequiredValueAccessor;
        }

        /// <inheritdoc/>
        public override Func<string, string> ValueMustNotBeNullAccessor => _valueMustNotBeNullAccessor;

        /// <summary>
        /// Sets the <see cref="ValueMustNotBeNullAccessor"/> property.
        /// </summary>
        /// <param name="valueMustNotBeNullAccessor">The value to set.</param>
        public void SetValueMustNotBeNullAccessor(Func<string, string> valueMustNotBeNullAccessor)
        {
            if (valueMustNotBeNullAccessor == null)
            {
                throw new ArgumentNullException(nameof(valueMustNotBeNullAccessor));
            }

            _valueMustNotBeNullAccessor = valueMustNotBeNullAccessor;
        }

        /// <inheritdoc/>
        public override Func<string, string, string> AttemptedValueIsInvalidAccessor => _attemptedValueIsInvalidAccessor;

        /// <summary>
        /// Sets the <see cref="AttemptedValueIsInvalidAccessor"/> property.
        /// </summary>
        /// <param name="attemptedValueIsInvalidAccessor">The value to set.</param>
        public void SetAttemptedValueIsInvalidAccessor(Func<string, string, string> attemptedValueIsInvalidAccessor)
        {
            if (attemptedValueIsInvalidAccessor == null)
            {
                throw new ArgumentNullException(nameof(attemptedValueIsInvalidAccessor));
            }

            _attemptedValueIsInvalidAccessor = attemptedValueIsInvalidAccessor;
        }

        /// <inheritdoc/>
        public override Func<string, string> NonPropertyAttemptedValueIsInvalidAccessor => _nonPropertyAttemptedValueIsInvalidAccessor;

        /// <summary>
        /// Sets the <see cref="NonPropertyAttemptedValueIsInvalidAccessor"/> property.
        /// </summary>
        /// <param name="nonPropertyAttemptedValueIsInvalidAccessor">The value to set.</param>
        public void SetNonPropertyAttemptedValueIsInvalidAccessor(
            Func<string, string> nonPropertyAttemptedValueIsInvalidAccessor)
        {
            if (nonPropertyAttemptedValueIsInvalidAccessor == null)
            {
                throw new ArgumentNullException(nameof(nonPropertyAttemptedValueIsInvalidAccessor));
            }

            _nonPropertyAttemptedValueIsInvalidAccessor = nonPropertyAttemptedValueIsInvalidAccessor;
        }

        /// <inheritdoc/>
        public override Func<string, string> UnknownValueIsInvalidAccessor => _unknownValueIsInvalidAccessor;

        /// <summary>
        /// Sets the <see cref="UnknownValueIsInvalidAccessor"/> property.
        /// </summary>
        /// <param name="unknownValueIsInvalidAccessor">The value to set.</param>
        public void SetUnknownValueIsInvalidAccessor(Func<string, string> unknownValueIsInvalidAccessor)
        {
            if (unknownValueIsInvalidAccessor == null)
            {
                throw new ArgumentNullException(nameof(unknownValueIsInvalidAccessor));
            }

            _unknownValueIsInvalidAccessor = unknownValueIsInvalidAccessor;
        }

        /// <inheritdoc/>
        public override Func<string> NonPropertyUnknownValueIsInvalidAccessor => _nonPropertyUnknownValueIsInvalidAccessor;

        /// <summary>
        /// Sets the <see cref="NonPropertyUnknownValueIsInvalidAccessor"/> property.
        /// </summary>
        /// <param name="nonPropertyUnknownValueIsInvalidAccessor">The value to set.</param>
        public void SetNonPropertyUnknownValueIsInvalidAccessor(Func<string> nonPropertyUnknownValueIsInvalidAccessor)
        {
            if (nonPropertyUnknownValueIsInvalidAccessor == null)
            {
                throw new ArgumentNullException(nameof(nonPropertyUnknownValueIsInvalidAccessor));
            }

            _nonPropertyUnknownValueIsInvalidAccessor = nonPropertyUnknownValueIsInvalidAccessor;
        }

        /// <inheritdoc/>
        public override Func<string, string> ValueIsInvalidAccessor => _valueIsInvalidAccessor;

        /// <summary>
        /// Sets the <see cref="ValueIsInvalidAccessor"/> property.
        /// </summary>
        /// <param name="valueIsInvalidAccessor">The value to set.</param>
        public void SetValueIsInvalidAccessor(Func<string, string> valueIsInvalidAccessor)
        {
            if (valueIsInvalidAccessor == null)
            {
                throw new ArgumentNullException(nameof(valueIsInvalidAccessor));
            }

            _valueIsInvalidAccessor = valueIsInvalidAccessor;
        }

        /// <inheritdoc/>
        public override Func<string, string> ValueMustBeANumberAccessor => _valueMustBeANumberAccessor;

        /// <summary>
        /// Sets the <see cref="ValueMustBeANumberAccessor"/> property.
        /// </summary>
        /// <param name="valueMustBeANumberAccessor">The value to set.</param>
        public void SetValueMustBeANumberAccessor(Func<string, string> valueMustBeANumberAccessor)
        {
            if (valueMustBeANumberAccessor == null)
            {
                throw new ArgumentNullException(nameof(valueMustBeANumberAccessor));
            }

            _valueMustBeANumberAccessor = valueMustBeANumberAccessor;
        }

        /// <inheritdoc/>
        public override Func<string> NonPropertyValueMustBeANumberAccessor => _nonPropertyValueMustBeANumberAccessor;

        /// <summary>
        /// Sets the <see cref="NonPropertyValueMustBeANumberAccessor"/> property.
        /// </summary>
        /// <param name="nonPropertyValueMustBeANumberAccessor">The value to set.</param>
        public void SetNonPropertyValueMustBeANumberAccessor(Func<string> nonPropertyValueMustBeANumberAccessor)
        {
            if (nonPropertyValueMustBeANumberAccessor == null)
            {
                throw new ArgumentNullException(nameof(nonPropertyValueMustBeANumberAccessor));
            }

            _nonPropertyValueMustBeANumberAccessor = nonPropertyValueMustBeANumberAccessor;
        }
    }
}