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.

99 lines
3.9 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. namespace Newtonsoft.Json
  27. {
  28. /// <summary>
  29. /// Instructs the <see cref="JsonSerializer"/> how to serialize the object.
  30. /// </summary>
  31. [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Interface, AllowMultiple = false)]
  32. internal sealed class JsonObjectAttribute : JsonContainerAttribute
  33. {
  34. private MemberSerialization _memberSerialization = MemberSerialization.OptOut;
  35. // yuck. can't set nullable properties on an attribute in C#
  36. // have to use this approach to get an unset default state
  37. internal Required? _itemRequired;
  38. internal NullValueHandling? _itemNullValueHandling;
  39. /// <summary>
  40. /// Gets or sets the member serialization.
  41. /// </summary>
  42. /// <value>The member serialization.</value>
  43. public MemberSerialization MemberSerialization
  44. {
  45. get => _memberSerialization;
  46. set => _memberSerialization = value;
  47. }
  48. /// <summary>
  49. /// Gets or sets how the object's properties with null values are handled during serialization and deserialization.
  50. /// </summary>
  51. /// <value>How the object's properties with null values are handled during serialization and deserialization.</value>
  52. public NullValueHandling ItemNullValueHandling
  53. {
  54. get => _itemNullValueHandling ?? default(NullValueHandling);
  55. set => _itemNullValueHandling = value;
  56. }
  57. /// <summary>
  58. /// Gets or sets a value that indicates whether the object's properties are required.
  59. /// </summary>
  60. /// <value>
  61. /// A value indicating whether the object's properties are required.
  62. /// </value>
  63. public Required ItemRequired
  64. {
  65. get => _itemRequired ?? default(Required);
  66. set => _itemRequired = value;
  67. }
  68. /// <summary>
  69. /// Initializes a new instance of the <see cref="JsonObjectAttribute"/> class.
  70. /// </summary>
  71. public JsonObjectAttribute()
  72. {
  73. }
  74. /// <summary>
  75. /// Initializes a new instance of the <see cref="JsonObjectAttribute"/> class with the specified member serialization.
  76. /// </summary>
  77. /// <param name="memberSerialization">The member serialization.</param>
  78. public JsonObjectAttribute(MemberSerialization memberSerialization)
  79. {
  80. MemberSerialization = memberSerialization;
  81. }
  82. /// <summary>
  83. /// Initializes a new instance of the <see cref="JsonObjectAttribute"/> class with the specified container Id.
  84. /// </summary>
  85. /// <param name="id">The container Id.</param>
  86. public JsonObjectAttribute(string id)
  87. : base(id)
  88. {
  89. }
  90. }
  91. }