JAVA-2809 Deprecate snapshot option for the find command

This option is deprecated in MongoDB 3.6 and removed in MongoDB 4.0,
so deprecating it in the driver as well.

Author: jyemin

driver-async/src/main/com/mongodb/async/client/FindIterable.java

@@ -244,6 +244,8 @@ public interface FindIterable<T> extends MongoIterable<T> {
      * @param snapshot the snapshot
      * @return this
      * @since 3.5
+     * @deprecated Deprecated in MongoDB 3.6 release and removed in MongoDB 4.0 release
      */
+    @Deprecated
     FindIterable<T> snapshot(boolean snapshot);
 }

driver-async/src/main/com/mongodb/async/client/FindIterableImpl.java

@@ -185,6 +185,7 @@ public FindIterable<TResult> showRecordId(final boolean showRecordId) {
     }
 
     @Override
+    @Deprecated
     public FindIterable<TResult> snapshot(final boolean snapshot) {
         findOptions.snapshot(snapshot);
         return this;

driver-core/src/main/com/mongodb/client/model/FindOptions.java

@@ -581,7 +581,9 @@ public FindOptions showRecordId(final boolean showRecordId) {
      *
      * @return the snapshot
      * @since 3.5
+     * @deprecated Deprecated in MongoDB 3.6 release and removed in MongoDB 4.0 release
      */
+    @Deprecated
     public boolean isSnapshot() {
         return snapshot;
     }
@@ -594,7 +596,9 @@ public boolean isSnapshot() {
      * @param snapshot the snapshot
      * @return this
      * @since 3.5
+     * @deprecated Deprecated in MongoDB 3.6 release and removed in MongoDB 4.0 release
      */
+    @Deprecated
     public FindOptions snapshot(final boolean snapshot) {
         this.snapshot = snapshot;
         return this;

driver-core/src/main/com/mongodb/operation/FindOperation.java

@@ -667,7 +667,9 @@ public FindOperation<T> showRecordId(final boolean showRecordId) {
      *
      * @return the snapshot
      * @since 3.5
+     * @deprecated Deprecated in MongoDB 3.6 release and removed in MongoDB 4.0 release
      */
+    @Deprecated
     public boolean isSnapshot() {
         return snapshot;
     }
@@ -680,7 +682,9 @@ public boolean isSnapshot() {
      * @param snapshot the snapshot
      * @return this
      * @since 3.5
+     * @deprecated Deprecated in MongoDB 3.6 release and removed in MongoDB 4.0 release
      */
+    @Deprecated
     public FindOperation<T> snapshot(final boolean snapshot) {
         this.snapshot = snapshot;
         return this;

driver-legacy/src/main/com/mongodb/DBCursor.java

@@ -292,6 +292,7 @@ public int getBatchSize() {
      * @return {@code this} so calls can be chained
      * @mongodb.driver.manual reference/operator Special Operators
      */
+    @SuppressWarnings("deprecation")
     public DBCursor addSpecial(@Nullable final String name, @Nullable final Object value) {
         if (name == null || value == null) {
             return this;
@@ -461,7 +462,9 @@ public DBCursor maxTime(final long maxTime, final TimeUnit timeUnit) {
      * @see com.mongodb.DBCursor#sort(DBObject)
      * @see com.mongodb.DBCursor#hint(DBObject)
      * @mongodb.driver.manual reference/operator/meta/snapshot/ $snapshot
+     * @deprecated Deprecated in MongoDB 3.6 release and removed in MongoDB 4.0 release
      */
+    @Deprecated
     public DBCursor snapshot() {
         findOptions.getModifiers().put("$snapshot", true);
         return this;

driver-legacy/src/test/functional/com/mongodb/DBCursorOldTest.java

@@ -83,6 +83,7 @@ public void testCount() {
     }
 
     @Test
+    @SuppressWarnings("deprecation")
     public void testSnapshot() {
         assumeTrue(serverVersionLessThan("3.7"));
         insertTestData(collection, 100);

driver-sync/src/main/com/mongodb/client/FindIterable.java

@@ -245,6 +245,8 @@ public interface FindIterable<TResult> extends MongoIterable<TResult> {
      * @param snapshot the snapshot
      * @return this
      * @since 3.5
+     * @deprecated Deprecated in MongoDB 3.6 release and removed in MongoDB 4.0 release
      */
+    @Deprecated
     FindIterable<TResult> snapshot(boolean snapshot);
 }

driver-sync/src/main/com/mongodb/client/internal/FindIterableImpl.java

@@ -186,6 +186,7 @@ public FindIterable<TResult> showRecordId(final boolean showRecordId) {
     }
 
     @Override
+    @Deprecated
     public FindIterable<TResult> snapshot(final boolean snapshot) {
         findOptions.snapshot(snapshot);
         return this;