You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

76 lines
3.3 KiB

  1. #region License
  2. // Copyright (c) 2007 James Newton-King
  3. //
  4. // Permission is hereby granted, free of charge, to any person
  5. // obtaining a copy of this software and associated documentation
  6. // files (the "Software"), to deal in the Software without
  7. // restriction, including without limitation the rights to use,
  8. // copy, modify, merge, publish, distribute, sublicense, and/or sell
  9. // copies of the Software, and to permit persons to whom the
  10. // Software is furnished to do so, subject to the following
  11. // conditions:
  12. //
  13. // The above copyright notice and this permission notice shall be
  14. // included in all copies or substantial portions of the Software.
  15. //
  16. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17. // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  18. // OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19. // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  20. // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  21. // WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  22. // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  23. // OTHER DEALINGS IN THE SOFTWARE.
  24. #endregion
  25. using System;
  26. using Newtonsoft.Json.Utilities;
  27. using System.Globalization;
  28. namespace Newtonsoft.Json
  29. {
  30. /// <summary>
  31. /// Instructs the <see cref="JsonSerializer"/> to use the specified <see cref="JsonConverter"/> when serializing the member or class.
  32. /// </summary>
  33. [AttributeUsage(AttributeTargets.Field | AttributeTargets.Property | AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Interface | AttributeTargets.Enum | AttributeTargets.Parameter, AllowMultiple = false)]
  34. internal sealed class JsonConverterAttribute : Attribute
  35. {
  36. private readonly Type _converterType;
  37. /// <summary>
  38. /// Gets the <see cref="Type"/> of the <see cref="JsonConverter"/>.
  39. /// </summary>
  40. /// <value>The <see cref="Type"/> of the <see cref="JsonConverter"/>.</value>
  41. public Type ConverterType => _converterType;
  42. /// <summary>
  43. /// The parameter list to use when constructing the <see cref="JsonConverter"/> described by <see cref="ConverterType"/>.
  44. /// If <c>null</c>, the default constructor is used.
  45. /// </summary>
  46. public object[] ConverterParameters { get; }
  47. /// <summary>
  48. /// Initializes a new instance of the <see cref="JsonConverterAttribute"/> class.
  49. /// </summary>
  50. /// <param name="converterType">Type of the <see cref="JsonConverter"/>.</param>
  51. public JsonConverterAttribute(Type converterType)
  52. {
  53. if (converterType == null)
  54. {
  55. throw new ArgumentNullException(nameof(converterType));
  56. }
  57. _converterType = converterType;
  58. }
  59. /// <summary>
  60. /// Initializes a new instance of the <see cref="JsonConverterAttribute"/> class.
  61. /// </summary>
  62. /// <param name="converterType">Type of the <see cref="JsonConverter"/>.</param>
  63. /// <param name="converterParameters">Parameter list to use when constructing the <see cref="JsonConverter"/>. Can be <c>null</c>.</param>
  64. public JsonConverterAttribute(Type converterType, params object[] converterParameters)
  65. : this(converterType)
  66. {
  67. ConverterParameters = converterParameters;
  68. }
  69. }
  70. }