JAVA-2808 Deprecate maxScan option for the find command

This option is deprecated in MongoDB 4.0 and will be removed in a
future release of the server, so deprecating it in the driver as well.

Author: jyemin

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

@@ -213,7 +213,9 @@ public interface FindIterable<T> extends MongoIterable<T> {
      * @param maxScan the maxScan
      * @return this
      * @since 3.5
+     * @deprecated Deprecated as of MongoDB 4.0 release
      */
+    @Deprecated
     FindIterable<T> maxScan(long maxScan);
 
     /**

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

@@ -166,6 +166,7 @@ public FindIterable<TResult> min(@Nullable final Bson min) {
     }
 
     @Override
+    @Deprecated
     public FindIterable<TResult> maxScan(final long maxScan) {
         findOptions.maxScan(maxScan);
         return this;

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

@@ -502,7 +502,9 @@ public FindOptions min(@Nullable final Bson min) {
      *
      * @return the maxScan
      * @since 3.5
+     * @deprecated Deprecated as of MongoDB 4.0 release
      */
+    @Deprecated
     public long getMaxScan() {
         return maxScan;
     }
@@ -515,7 +517,9 @@ public long getMaxScan() {
      * @param maxScan the maxScan
      * @return this
      * @since 3.5
+     * @deprecated Deprecated as of MongoDB 4.0 release
      */
+    @Deprecated
     public FindOptions maxScan(final long maxScan) {
         this.maxScan = maxScan;
         return this;

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

@@ -588,7 +588,9 @@ public FindOperation<T> min(final BsonDocument min) {
      *
      * @return the maxScan
      * @since 3.5
+     * @deprecated Deprecated as of MongoDB 4.0 release
      */
+    @Deprecated
     public long getMaxScan() {
         return maxScan;
     }
@@ -601,7 +603,9 @@ public long getMaxScan() {
      * @param maxScan the maxScan
      * @return this
      * @since 3.5
+     * @deprecated Deprecated as of MongoDB 4.0 release
      */
+    @Deprecated
     public FindOperation<T> maxScan(final long maxScan) {
         this.maxScan = maxScan;
         return this;

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

@@ -281,10 +281,10 @@ public int getBatchSize() {
     }
 
     /**
-     * Adds a special operator like $maxScan or $returnKey. For example:
+     * Adds a special operator like $comment or $returnKey. For example:
      * <pre>
      *    addSpecial("$returnKey", 1)
-     *    addSpecial("$maxScan", 100)
+     *    addSpecial("$comment", "this is a special query)
      * </pre>
      *
      * @param name  the name of the special query operator
@@ -352,7 +352,9 @@ public DBCursor comment(final String comment) {
      * @mongodb.driver.manual reference/operator/meta/maxScan/ $maxScan
      * @see #limit(int)
      * @since 2.12
+     * @deprecated Deprecated as of MongoDB 4.0 release
      */
+    @Deprecated
     public DBCursor maxScan(final int max) {
         findOptions.getModifiers().put("$maxScan", max);
         return this;

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

@@ -309,6 +309,7 @@ public void testConstructor() {
     }
 
     @Test
+    @SuppressWarnings("deprecation")
     public void testMaxScan() {
         countResults(new DBCursor(collection, new BasicDBObject(), new BasicDBObject(), ReadPreference.primary())
                      .addSpecial("$maxScan", 4), 4);

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

@@ -214,7 +214,9 @@ public interface FindIterable<TResult> extends MongoIterable<TResult> {
      * @param maxScan the maxScan
      * @return this
      * @since 3.5
+     * @deprecated Deprecated as of MongoDB 4.0 release
      */
+    @Deprecated
     FindIterable<TResult> maxScan(long maxScan);
 
     /**

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

@@ -167,6 +167,7 @@ public FindIterable<TResult> min(@Nullable final Bson min) {
     }
 
     @Override
+    @Deprecated
     public FindIterable<TResult> maxScan(final long maxScan) {
         findOptions.maxScan(maxScan);
         return this;