BsonElementAttribute.cs 2.3 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 element name and related options for a field or property.
  20. /// </summary>
  21. [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
  22. public class BsonElementAttribute : Attribute, IBsonMemberMapAttribute
  23. {
  24. // private fields
  25. private string _elementName;
  26. private int _order = int.MaxValue;
  27. // constructors
  28. /// <summary>
  29. /// Initializes a new instance of the BsonElementAttribute class.
  30. /// </summary>
  31. public BsonElementAttribute()
  32. { }
  33. /// <summary>
  34. /// Initializes a new instance of the BsonElementAttribute class.
  35. /// </summary>
  36. /// <param name="elementName">The name of the element.</param>
  37. public BsonElementAttribute(string elementName)
  38. {
  39. _elementName = elementName;
  40. }
  41. // public properties
  42. /// <summary>
  43. /// Gets the element name.
  44. /// </summary>
  45. public string ElementName
  46. {
  47. get { return _elementName; }
  48. }
  49. /// <summary>
  50. /// Gets the element serialization order.
  51. /// </summary>
  52. public int Order
  53. {
  54. get { return _order; }
  55. set { _order = value; }
  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. if (!string.IsNullOrEmpty(_elementName))
  65. {
  66. memberMap.SetElementName(_elementName);
  67. }
  68. memberMap.SetOrder(_order);
  69. }
  70. }
  71. }