BsonDefaultValueAttribute.cs 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. /* Copyright 2010-present MongoDB Inc.
  2. *
  3. * Licensed under the Apache License, Version 2.0 (the "License");
  4. * you may not use this file except in compliance with the License.
  5. * You may obtain a copy of the License at
  6. *
  7. * http://www.apache.org/licenses/LICENSE-2.0
  8. *
  9. * Unless required by applicable law or agreed to in writing, software
  10. * distributed under the License is distributed on an "AS IS" BASIS,
  11. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. * See the License for the specific language governing permissions and
  13. * limitations under the License.
  14. */
  15. using System;
  16. namespace MongoDB.Bson.Serialization.Attributes
  17. {
  18. /// <summary>
  19. /// Specifies the default value for a field or property.
  20. /// </summary>
  21. [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
  22. public class BsonDefaultValueAttribute : Attribute, IBsonMemberMapAttribute
  23. {
  24. // private fields
  25. private object _defaultValue;
  26. private bool _serializeDefaultValue;
  27. private bool _serializeDefaultValueWasSet;
  28. // constructors
  29. /// <summary>
  30. /// Initializes a new instance of the BsonDefaultValueAttribute class.
  31. /// </summary>
  32. /// <param name="defaultValue">The default value.</param>
  33. public BsonDefaultValueAttribute(object defaultValue)
  34. {
  35. _defaultValue = defaultValue;
  36. }
  37. // public properties
  38. /// <summary>
  39. /// Gets the default value.
  40. /// </summary>
  41. public object DefaultValue
  42. {
  43. get { return _defaultValue; }
  44. }
  45. /// <summary>
  46. /// Gets or sets whether to serialize the default value.
  47. /// </summary>
  48. [Obsolete("Use BsonIgnoreIfDefaultAttribute instead.")]
  49. public bool SerializeDefaultValue
  50. {
  51. get { return _serializeDefaultValue; }
  52. set {
  53. _serializeDefaultValue = value;
  54. _serializeDefaultValueWasSet = true;
  55. }
  56. }
  57. // public methods
  58. /// <summary>
  59. /// Applies a modification to the member map.
  60. /// </summary>
  61. /// <param name="memberMap">The member map.</param>
  62. public void Apply(BsonMemberMap memberMap)
  63. {
  64. memberMap.SetDefaultValue(_defaultValue);
  65. if (_serializeDefaultValueWasSet)
  66. {
  67. memberMap.SetIgnoreIfNull(false);
  68. memberMap.SetIgnoreIfDefault(!_serializeDefaultValue);
  69. }
  70. }
  71. }
  72. }