BsonMinKey.cs 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  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
  17. {
  18. /// <summary>
  19. /// Represents the BSON MinKey value.
  20. /// </summary>
  21. #if NET452
  22. [Serializable]
  23. #endif
  24. public class BsonMinKey : BsonValue, IComparable<BsonMinKey>, IEquatable<BsonMinKey>
  25. {
  26. // private static fields
  27. private static BsonMinKey __value = new BsonMinKey();
  28. // constructors
  29. // private so only the singleton instance can be created
  30. private BsonMinKey()
  31. {
  32. }
  33. // public operators
  34. /// <summary>
  35. /// Compares two BsonMinKey values.
  36. /// </summary>
  37. /// <param name="lhs">The first BsonMinKey.</param>
  38. /// <param name="rhs">The other BsonMinKey.</param>
  39. /// <returns>True if the two BsonMinKey values are not equal according to ==.</returns>
  40. public static bool operator !=(BsonMinKey lhs, BsonMinKey rhs)
  41. {
  42. return !(lhs == rhs);
  43. }
  44. /// <summary>
  45. /// Compares two BsonMinKey values.
  46. /// </summary>
  47. /// <param name="lhs">The first BsonMinKey.</param>
  48. /// <param name="rhs">The other BsonMinKey.</param>
  49. /// <returns>True if the two BsonMinKey values are equal according to ==.</returns>
  50. public static bool operator ==(BsonMinKey lhs, BsonMinKey rhs)
  51. {
  52. if (object.ReferenceEquals(lhs, null)) { return object.ReferenceEquals(rhs, null); }
  53. return lhs.Equals(rhs);
  54. }
  55. // public static properties
  56. /// <summary>
  57. /// Gets the singleton instance of BsonMinKey.
  58. /// </summary>
  59. public static BsonMinKey Value { get { return __value; } }
  60. // public properties
  61. /// <summary>
  62. /// Gets the BsonType of this BsonValue.
  63. /// </summary>
  64. public override BsonType BsonType
  65. {
  66. get { return BsonType.MinKey; }
  67. }
  68. // public methods
  69. /// <summary>
  70. /// Compares this BsonMinKey to another BsonMinKey.
  71. /// </summary>
  72. /// <param name="other">The other BsonMinKey.</param>
  73. /// <returns>A 32-bit signed integer that indicates whether this BsonMinKey is less than, equal to, or greather than the other.</returns>
  74. public int CompareTo(BsonMinKey other)
  75. {
  76. if (other == null) { return 1; }
  77. return 0; // it's a singleton
  78. }
  79. /// <summary>
  80. /// Compares the BsonMinKey to another BsonValue.
  81. /// </summary>
  82. /// <param name="other">The other BsonValue.</param>
  83. /// <returns>A 32-bit signed integer that indicates whether this BsonMinKey is less than, equal to, or greather than the other BsonValue.</returns>
  84. public override int CompareTo(BsonValue other)
  85. {
  86. if (other == null) { return 1; }
  87. if (other is BsonMinKey) { return 0; }
  88. return -1;
  89. }
  90. /// <summary>
  91. /// Compares this BsonMinKey to another BsonMinKey.
  92. /// </summary>
  93. /// <param name="rhs">The other BsonMinKey.</param>
  94. /// <returns>True if the two BsonMinKey values are equal.</returns>
  95. public bool Equals(BsonMinKey rhs)
  96. {
  97. if (object.ReferenceEquals(rhs, null) || GetType() != rhs.GetType()) { return false; }
  98. return true; // it's a singleton
  99. }
  100. /// <summary>
  101. /// Compares this BsonMinKey to another object.
  102. /// </summary>
  103. /// <param name="obj">The other object.</param>
  104. /// <returns>True if the other object is a BsonMinKey and equal to this one.</returns>
  105. public override bool Equals(object obj)
  106. {
  107. return Equals(obj as BsonMinKey); // works even if obj is null or of a different type
  108. }
  109. /// <summary>
  110. /// Gets the hash code.
  111. /// </summary>
  112. /// <returns>The hash code.</returns>
  113. public override int GetHashCode()
  114. {
  115. return BsonType.GetHashCode();
  116. }
  117. /// <summary>
  118. /// Returns a string representation of the value.
  119. /// </summary>
  120. /// <returns>A string representation of the value.</returns>
  121. public override string ToString()
  122. {
  123. return "BsonMinKey";
  124. }
  125. }
  126. }