CSHARP-4886: Mark API that will be removed in 3.0 as obsolete: MongoDB.Bson

src/Directory.Build.props

@@ -51,4 +51,10 @@
     <None Include="..\..\LICENSE.md" Pack="true" PackagePath="$(PackageLicenseFile)" />
     <None Include="..\..\packageIcon.png" Pack="true" PackagePath="" />
   </ItemGroup>
+
+  <PropertyGroup>
+    <NoWarn>
+      CS0618 <!--Temporary disable obsolete warnings due the massive volume of warnings-->
+    </NoWarn>
+  </PropertyGroup>
 </Project>

src/MongoDB.Bson/BsonDefaults.cs

@@ -22,6 +22,7 @@ namespace MongoDB.Bson
     /// <summary>
     /// A static helper class containing BSON defaults.
     /// </summary>
+    [Obsolete("This class will be removed in later release.")]
     public static class BsonDefaults
     {
         // private static fields

src/MongoDB.Bson/IO/BsonBinaryReaderSettings.cs

@@ -45,6 +45,7 @@ public BsonBinaryReaderSettings()
         /// <summary>
         /// Gets or sets the default settings for a BsonBinaryReader.
         /// </summary>
+        [Obsolete("This property will be removed in later release.")]
         public static BsonBinaryReaderSettings Defaults
         {
             get

src/MongoDB.Bson/IO/BsonBinaryWriterSettings.cs

@@ -44,6 +44,7 @@ public BsonBinaryWriterSettings()
         /// <summary>
         /// Gets or sets the default BsonBinaryWriter settings.
         /// </summary>
+        [Obsolete("This property will be removed in later release.")]
         public static BsonBinaryWriterSettings Defaults
         {
             get

src/MongoDB.Bson/IO/BsonDocumentReaderSettings.cs

@@ -48,6 +48,7 @@ public BsonDocumentReaderSettings(GuidRepresentation guidRepresentation)
         /// <summary>
         /// Gets or sets the default settings for a BsonDocumentReader.
         /// </summary>
+        [Obsolete("This property will be removed in later release.")]
         public static BsonDocumentReaderSettings Defaults
         {
             get

src/MongoDB.Bson/IO/BsonDocumentWriterSettings.cs

@@ -48,6 +48,7 @@ public BsonDocumentWriterSettings(GuidRepresentation guidRepresentation)
         /// <summary>
         /// Gets or sets the default BsonDocumentWriter settings.
         /// </summary>
+        [Obsolete("This property will be removed in later release.")]
         public static BsonDocumentWriterSettings Defaults
         {
             get

src/MongoDB.Bson/IO/BsonTrie.cs

@@ -21,6 +21,7 @@ namespace MongoDB.Bson.IO
     /// Represents a mapping from a set of UTF8 encoded strings to a set of elementName/value pairs, implemented as a trie.
     /// </summary>
     /// <typeparam name="TValue">The type of the BsonTrie values.</typeparam>
+    [Obsolete("This class will be removed in later release.")]
     public class BsonTrie<TValue>
     {
         // private fields

src/MongoDB.Bson/IO/BsonWriter.cs

@@ -100,7 +100,6 @@ protected string Name
             get { return _name; }
         }
 
-        // public static methods
         // public methods
         /// <summary>
         /// Closes the writer.

src/MongoDB.Bson/IO/ByteArrayChunk.cs

@@ -20,6 +20,7 @@ namespace MongoDB.Bson.IO
     /// <summary>
     /// Represents a chunk backed by a byte array.
     /// </summary>
+    [Obsolete("This class will be removed in later release.")]
     public class ByteArrayChunk : IBsonChunk
     {
         #region static

src/MongoDB.Bson/IO/ByteBufferFactory.cs

@@ -22,6 +22,8 @@ namespace MongoDB.Bson.IO
     /// <summary>
     /// Represents a factory for IBsonBuffers.
     /// </summary>
+    /// ByteBufferFactory
+    [Obsolete("This class will be removed in later release.")]
     public static class ByteBufferFactory
     {
         /// <summary>

src/MongoDB.Bson/IO/ByteBufferSlice.cs

@@ -21,6 +21,7 @@ namespace MongoDB.Bson.IO
     /// <summary>
     /// Represents a slice of a byte buffer.
     /// </summary>
+    [Obsolete("This class will be removed in later release.")]
     public class ByteBufferSlice : IByteBuffer
     {
         private readonly IByteBuffer _buffer;

src/MongoDB.Bson/IO/IStreamEfficientCopyTo.cs

@@ -13,13 +13,15 @@
 * limitations under the License.
 */
 
+using System;
 using System.IO;
 
 namespace MongoDB.Bson.IO
 {
     /// <summary>
     /// Represents the effective CopyTo method.
     /// </summary>
+    [Obsolete("This interface will be removed in later release.")]
     public interface IStreamEfficientCopyTo
     {
         /// <summary>

src/MongoDB.Bson/IO/JsonReaderSettings.cs

@@ -38,6 +38,7 @@ public JsonReaderSettings()
         /// <summary>
         /// Gets or sets the default settings for a JsonReader.
         /// </summary>
+        [Obsolete("This property will be removed in later release.")]
         public static JsonReaderSettings Defaults
         {
             get

src/MongoDB.Bson/IO/JsonWriterSettings.cs

@@ -47,6 +47,7 @@ public JsonWriterSettings()
         /// <summary>
         /// Gets or sets the default JsonWriterSettings.
         /// </summary>
+        [Obsolete("This property will be removed in later release.")]
         public static JsonWriterSettings Defaults
         {
             get

src/MongoDB.Bson/IO/TrieNameDecoder.cs

@@ -13,6 +13,7 @@
 * limitations under the License.
 */
 
+using System;
 using System.Text;
 
 namespace MongoDB.Bson.IO
@@ -21,6 +22,7 @@ namespace MongoDB.Bson.IO
     /// Represents a Trie-based name decoder that also provides a value.
     /// </summary>
     /// <typeparam name="TValue">The type of the value.</typeparam>
+    [Obsolete("This class will be removed in later release.")]
     public class TrieNameDecoder<TValue> : INameDecoder
     {
         // private fields

src/MongoDB.Bson/ObjectModel/BsonSymbol.cs

@@ -21,6 +21,7 @@ namespace MongoDB.Bson
     /// <summary>
     /// Represents a BSON symbol value.
     /// </summary>
+    [Obsolete("This class will be removed in later release.")]
     public class BsonSymbol : BsonValue, IComparable<BsonSymbol>, IEquatable<BsonSymbol>
     {
         // private fields

src/MongoDB.Bson/ObjectModel/BsonType.cs

@@ -47,10 +47,13 @@ public enum BsonType
         /// BSON binary data.
         /// </summary>
         Binary = 0x05,
+
         /// <summary>
         /// A BSON undefined value.
         /// </summary>
+        [Obsolete("Undefined type is depricated and will be removed in later release.")]
         Undefined = 0x06,
+
         /// <summary>
         /// A BSON ObjectId.
         /// </summary>
@@ -75,10 +78,13 @@ public enum BsonType
         /// BSON JavaScript code.
         /// </summary>
         JavaScript = 0x0d,
+
         /// <summary>
         /// A BSON symbol.
         /// </summary>
+        [Obsolete("Symbol type is depricated and will be removed in later release.")]
         Symbol = 0x0e,
+
         /// <summary>
         /// BSON JavaScript code with a scope (a set of variables with values).
         /// </summary>

src/MongoDB.Bson/ObjectModel/BsonTypeMapper.cs

@@ -451,7 +451,7 @@ public static void RegisterCustomTypeMapper(Type type, ICustomBsonTypeMapper cus
         /// </summary>
         /// <param name="value">An object.</param>
         /// <param name="bsonValue">The BsonValue.</param>
-        /// <returns>True if the mapping was successfull.</returns>
+        /// <returns>True if the mapping was successful.</returns>
         public static bool TryMapToBsonValue(object value, out BsonValue bsonValue)
         {
             if (value == null)

src/MongoDB.Bson/ObjectModel/BsonTypeMapperOptions.cs

@@ -64,6 +64,7 @@ public BsonTypeMapperOptions()
         /// <summary>
         /// Gets or sets the default BsonTypeMapperOptions.
         /// </summary>
+        [Obsolete("This property will be removed in later release.")]
         public static BsonTypeMapperOptions Defaults
         {
             get { return __defaults; }

src/MongoDB.Bson/ObjectModel/ICustomBsonTypeMapper.cs

@@ -25,7 +25,7 @@ public interface ICustomBsonTypeMapper
         /// </summary>
         /// <param name="value">An object.</param>
         /// <param name="bsonValue">The BsonValue.</param>
-        /// <returns>True if the mapping was successfull.</returns>
+        /// <returns>True if the mapping was successful.</returns>
         bool TryMapToBsonValue(object value, out BsonValue bsonValue);
     }
 }

src/MongoDB.Bson/Serialization/AttributedSerializationProvider.cs

@@ -23,6 +23,7 @@ namespace MongoDB.Bson.Serialization
     /// <summary>
     /// Provides serializers based on an attribute.
     /// </summary>
+    [Obsolete("This class will be removed in later release.")]
     public class AttributedSerializationProvider : BsonSerializationProviderBase
     {
         /// <inheritdoc/>

src/MongoDB.Bson/Serialization/BsonClassMap.cs

@@ -323,6 +323,7 @@ public static bool IsClassMapRegistered(Type type)
         /// </summary>
         /// <param name="classType">The class type.</param>
         /// <returns>The class map.</returns>
+        [Obsolete("This method will be removed in later release.")]
         public static BsonClassMap LookupClassMap(Type classType)
         {
             if (classType == null)

src/MongoDB.Bson/Serialization/BsonObjectModelSerializationProvider.cs

@@ -23,6 +23,7 @@ namespace MongoDB.Bson.Serialization
     /// <summary>
     /// Provides serializers for BsonValue and its derivations.
     /// </summary>
+    [Obsolete("This class will be removed in later release.")]
     public class BsonObjectModelSerializationProvider : BsonSerializationProviderBase
     {
         private static readonly Dictionary<Type, IBsonSerializer> __serializers;

src/MongoDB.Bson/Serialization/CollectionsSerializationProvider.cs

@@ -28,6 +28,7 @@ namespace MongoDB.Bson.Serialization
     /// <summary>
     /// Provides serializers for collections.
     /// </summary>
+    [Obsolete("This class will be removed in later release.")]
     public class CollectionsSerializationProvider : BsonSerializationProviderBase
     {
         private static readonly Dictionary<Type, Type> __serializerTypes;

src/MongoDB.Bson/Serialization/Conventions/ReadWriteMemberFinderConvention.cs

@@ -18,7 +18,7 @@
 namespace MongoDB.Bson.Serialization.Conventions
 {
     /// <summary>
-    /// A convention that finds readable and writeable members and adds them to the class map.
+    /// A convention that finds readable and writable members and adds them to the class map.
     /// </summary>
     public class ReadWriteMemberFinderConvention : ConventionBase, IClassMapConvention
     {

src/MongoDB.Bson/Serialization/CreatorMapDelegateCompiler.cs

@@ -24,6 +24,7 @@ namespace MongoDB.Bson.Serialization
     /// <summary>
     /// A helper class used to create and compile delegates for creator maps.
     /// </summary>
+    [Obsolete("This class will be removed in later release.")]
     public class CreatorMapDelegateCompiler : ExpressionVisitor
     {
         // private fields

src/MongoDB.Bson/Serialization/DiscriminatedInterfaceSerializationProvider.cs

@@ -22,6 +22,7 @@ namespace MongoDB.Bson.Serialization
     /// <summary>
     /// Provides a serializer for interfaces.
     /// </summary>
+    [Obsolete("This class will be removed in later release.")]
     public class DiscriminatedInterfaceSerializationProvider : BsonSerializationProviderBase
     {
         /// <inheritdoc/>

src/MongoDB.Bson/Serialization/ExpressionVisitor.cs

@@ -26,6 +26,7 @@ namespace MongoDB.Bson.Serialization
     /// <summary>
     /// An abstract base class for an Expression visitor.
     /// </summary>
+    [Obsolete("This class will be removed in later release.")]
     public abstract class ExpressionVisitor
     {
         // constructors
@@ -41,7 +42,7 @@ protected ExpressionVisitor()
         /// Visits an Expression.
         /// </summary>
         /// <param name="node">The Expression.</param>
-        /// <returns>The Expression (posibly modified).</returns>
+        /// <returns>The Expression (possibly modified).</returns>
         protected virtual Expression Visit(Expression node)
         {
             if (node == null)

src/MongoDB.Bson/Serialization/IBsonSerializationProvider.cs

@@ -34,8 +34,9 @@ public interface IBsonSerializationProvider
     /// An interface implemented by serialization providers that are aware of registries.
     /// </summary>
     /// <remarks>
-    /// This interface was added to preserve backward compatability (changing IBsonSerializationProvider would have been a backward breaking change).
+    /// This interface was added to preserve backward compatibility (changing IBsonSerializationProvider would have been a backward breaking change).
     /// </remarks>
+    [Obsolete("This interface will be merged with IBsonSerializationProvider interface in later release.")]
     public interface IRegistryAwareBsonSerializationProvider : IBsonSerializationProvider
     {
         /// <summary>

src/MongoDB.Bson/Serialization/IdGenerators/BsonBinaryDataGuidGenerator.cs

@@ -78,13 +78,22 @@ public static BsonBinaryDataGuidGenerator StandardInstance
         }
 
         /// <summary>
-        /// Gets an instance of BsonBinaryDataGuidGenerator for Unspecifed GuidRepresentation.
+        /// Gets an instance of BsonBinaryDataGuidGenerator for Unspecified GuidRepresentation.
         /// </summary>
+        [Obsolete("This method will be removed in later release. Please use UnspecifiedInstance instead")]
         public static BsonBinaryDataGuidGenerator UnspecifedInstance
         {
             get { return __unspecifiedInstance; }
         }
 
+        /// <summary>
+        /// Gets an instance of BsonBinaryDataGuidGenerator for Unspecified GuidRepresentation.
+        /// </summary>
+        public static BsonBinaryDataGuidGenerator UnspecifiedInstance
+        {
+            get { return __unspecifiedInstance; }
+        }
+
         // public properties
         /// <summary>
         /// Gets the Guid representation.

src/MongoDB.Bson/Serialization/IdGenerators/ZeroIdChecker.cs

@@ -22,6 +22,7 @@ namespace MongoDB.Bson.Serialization.IdGenerators
     /// </summary>
     /// <typeparam name="T">The type of the Id.</typeparam>
     // TODO: is it worth trying to remove the dependency on IEquatable<T>?
+    [Obsolete("This class will be removed in later release.")]
     public class ZeroIdChecker<T> : IIdGenerator where T : struct, IEquatable<T>
     {
         // constructors

src/MongoDB.Bson/Serialization/PrimitiveSerializationProvider.cs

@@ -26,6 +26,7 @@ namespace MongoDB.Bson.Serialization
     /// <summary>
     /// Provides serializers for primitive types.
     /// </summary>
+    [Obsolete("This class will be removed in later release.")]
     public class PrimitiveSerializationProvider : BsonSerializationProviderBase
     {
         private static readonly Dictionary<Type, Type> __serializersTypes;

src/MongoDB.Bson/Serialization/Serializers/SerializerHelper.cs

@@ -22,6 +22,7 @@ namespace MongoDB.Bson.Serialization.Serializers
     /// <summary>
     /// Represents a helper for serializers.
     /// </summary>
+    [Obsolete("This class will be removed in later release.")]
     public class SerializerHelper
     {
         // private fields
@@ -138,6 +139,7 @@ private Member FindFirstMissingRequiredMember(long missingRequiredMemberFlags)
         /// <summary>
         /// Represents information about a member.
         /// </summary>
+        [Obsolete("This class will be removed in later release.")]
         public class Member
         {
             // private static fields

src/MongoDB.Bson/Serialization/Serializers/TupleSerializers.cs

@@ -26,7 +26,7 @@ namespace MongoDB.Bson.Serialization.Serializers
     public interface IBsonTupleSerializer
     {
         /// <summary>
-        /// Gets ths serializer for an item.
+        /// Gets this serializer for an item.
         /// </summary>
         /// <param name="itemNumber">The item number.</param>
         /// <returns>The serializer for the item.</returns>

src/MongoDB.Bson/Serialization/TypeMappingSerializationProvider.cs

@@ -22,6 +22,7 @@ namespace MongoDB.Bson.Serialization
     /// <summary>
     /// Represents a serialization provider based on a mapping from value types to serializer types.
     /// </summary>
+    [Obsolete("This class will be removed in later release.")]
     public sealed class TypeMappingSerializationProvider : BsonSerializationProviderBase
     {
         // private fields

src/MongoDB.Driver.Core/MongoDB.Driver.Core.csproj

@@ -17,7 +17,10 @@
   </PropertyGroup>
 
   <PropertyGroup>
-    <NoWarn>NU5100</NoWarn>
+    <NoWarn>
+      NU5100;
+      CS0618 <!--Temporary disable obsolete warnings due the massive volume of warnings-->
+    </NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

tests/BuildProps/Tests.Build.props

@@ -54,4 +54,25 @@
     </PackageReference>
   </ItemGroup>
 
+  <PropertyGroup>
+    <NoWarn>
+      1701;1702; <!--https://github.com/dotnet/roslyn/issues/19640-->
+      CS0618; <!--Temporary disable obsolete warnings due the massive volume of warnings-->
+      xUnit1010; <!--The value is not convertible to the method parameter type (https://xunit.github.io/xunit.analyzers/rules/xUnit1010.html)-->
+      xUnit1013; <!--Public method should be marked as test (https://xunit.github.io/xunit.analyzers/rules/xUnit1013.html)-->
+      xUnit1016; <!--MemberData must reference a public member (https://xunit.github.io/xunit.analyzers/rules/xUnit1016.html)-->
+      xUnit1024; <!--Test methods cannot have overloads (https://xunit.github.io/xunit.analyzers/rules/xUnit1024.html)-->
+      xUnit1025; <!--InlineData should be unique within the Theory it belongs to (https://xunit.github.io/xunit.analyzers/rules/xUnit1025.html)-->
+      xUnit1026; <!--Theory methods should use all of their parameters (https://xunit.github.io/xunit.analyzers/rules/xUnit1026.html)-->
+      xUnit2000; <!--Constants and literals should be the expected argument (https://xunit.github.io/xunit.analyzers/rules/xUnit2000.html-->
+      xUnit2003; <!--Do not use equality check to test for null value (https://xunit.github.io/xunit.analyzers/rules/xUnit2003.html-->
+      xUnit2004; <!--Do not use equality check to test for boolean conditions (https://xunit.github.io/xunit.analyzers/rules/xUnit2004.html)-->
+      xUnit2005; <!--Do not use identity check on value type (https://xunit.github.io/xunit.analyzers/rules/xUnit205.html-->
+      xUnit2009; <!--Do not use boolean check to check for substrings (https://xunit.github.io/xunit.analyzers/rules/xUnit2009.html)-->
+      xUnit2012; <!--Do not use Enumerable.Any() to check if a value exists in a collection (https://xunit.github.io/xunit.analyzers/rules/xUnit2012.html)-->
+      xUnit2013; <!--Do not use equality check to check for collection size. (https://xunit.github.io/xunit.analyzers/rules/xUnit2013.html)-->
+      xUnit2015; <!--Do not use typeof expression to check the exception type (https://xunit.github.io/xunit.analyzers/rules/xUnit2015.html)-->
+      xUnit2017; <!--Do not use Contains() to check if a value exists in a collection (https://xunit.github.io/xunit.analyzers/rules/xUnit2017.html)-->
+    </NoWarn>
+  </PropertyGroup>
 </Project>