Deprecate the mongodb-driver-async module

jyemin · jyemin · commit 0060faee8ddf · 2018-10-22T10:36:15.000-04:00
The mongodb-driver-async module API is based on callbacks, which are difficult and error-prone to program against. Since this API was introduced, the industry has standardize around http://www.reactive-streams.org/ and, more recently, java.util.concurrent.Flow (introduced in Java 9). Given this trend, it is no longer advantageous to maintain the callback-based public API; it is now deprecated and the intention is to remove it in the next major release of the driver. JAVA-3008
diff --git a/driver-async/src/main/com/mongodb/async/client/AggregateIterable.java b/driver-async/src/main/com/mongodb/async/client/AggregateIterable.java
@@ -28,7 +28,9 @@
  *
  * @param <TResult> The type of the result.
  * @since 3.0
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public interface AggregateIterable<TResult> extends MongoIterable<TResult> {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/ChangeStreamIterable.java b/driver-async/src/main/com/mongodb/async/client/ChangeStreamIterable.java
@@ -34,7 +34,9 @@
  * @param <TResult> The type of the result.
  * @mongodb.server.release 3.6
  * @since 3.6
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public interface ChangeStreamIterable<TResult> extends MongoIterable<ChangeStreamDocument<TResult>> {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/ClientSession.java b/driver-async/src/main/com/mongodb/async/client/ClientSession.java
@@ -23,7 +23,9 @@
  * A client session that supports transactions.
  *
  * @since 3.8
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public interface ClientSession extends com.mongodb.session.ClientSession {
     /**
      * Returns true if there is an active transaction on this session, and false otherwise
diff --git a/driver-async/src/main/com/mongodb/async/client/DistinctIterable.java b/driver-async/src/main/com/mongodb/async/client/DistinctIterable.java
@@ -28,7 +28,9 @@
  *
  * @param <TResult> The type of the result.
  * @since 3.0
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public interface DistinctIterable<TResult> extends MongoIterable<TResult> {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/FindIterable.java b/driver-async/src/main/com/mongodb/async/client/FindIterable.java
@@ -28,7 +28,9 @@
  *
  * @param <T> The type of the result.
  * @since 3.0
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public interface FindIterable<T> extends MongoIterable<T> {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/ListCollectionsIterable.java b/driver-async/src/main/com/mongodb/async/client/ListCollectionsIterable.java
@@ -26,7 +26,9 @@
  *
  * @param <TResult> The type of the result.
  * @since 3.0
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public interface ListCollectionsIterable<TResult> extends MongoIterable<TResult> {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/ListDatabasesIterable.java b/driver-async/src/main/com/mongodb/async/client/ListDatabasesIterable.java
@@ -25,7 +25,9 @@
  * Iterable for ListDatabases.
  *
  * @param <T> The type of the result.
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public interface ListDatabasesIterable<T> extends MongoIterable<T> {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/ListIndexesIterable.java b/driver-async/src/main/com/mongodb/async/client/ListIndexesIterable.java
@@ -23,7 +23,9 @@
  *
  * @param <TResult> The type of the result.
  * @since 3.0
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public interface ListIndexesIterable<TResult> extends MongoIterable<TResult> {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/MapReduceIterable.java b/driver-async/src/main/com/mongodb/async/client/MapReduceIterable.java
@@ -30,7 +30,9 @@
  *
  * @param <TResult> The type of the result.
  * @since 3.0
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public interface MapReduceIterable<TResult> extends MongoIterable<TResult> {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/MongoClient.java b/driver-async/src/main/com/mongodb/async/client/MongoClient.java
@@ -33,8 +33,10 @@
  * Instance of this class serve as factories for {@code MongoDatabase} instances.
  * </p>
  * @since 3.0
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
 @Immutable
+@Deprecated
 public interface MongoClient extends Closeable {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/MongoClients.java b/driver-async/src/main/com/mongodb/async/client/MongoClients.java
@@ -36,8 +36,10 @@
  * A factory for MongoClient instances.
  *
  * @since 3.0
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
 @SuppressWarnings("deprecation")
+@Deprecated
 public final class MongoClients {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/MongoCollection.java b/driver-async/src/main/com/mongodb/async/client/MongoCollection.java
@@ -60,8 +60,10 @@
  *
  * @param <TDocument> The type that this collection will encode documents from and decode documents to.
  * @since 3.0
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
 @ThreadSafe
+@Deprecated
 public interface MongoCollection<TDocument> {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/MongoDatabase.java b/driver-async/src/main/com/mongodb/async/client/MongoDatabase.java
@@ -35,8 +35,10 @@
  * Note: Additions to this interface will not be considered to break binary compatibility.</p>
  *
  * @since 3.0
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
 @ThreadSafe
+@Deprecated
 public interface MongoDatabase {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/MongoIterable.java b/driver-async/src/main/com/mongodb/async/client/MongoIterable.java
@@ -29,7 +29,9 @@
  *
  * @param <TResult> the result type
  * @since 3.0
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public interface MongoIterable<TResult> {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/Observable.java b/driver-async/src/main/com/mongodb/async/client/Observable.java
@@ -26,7 +26,9 @@
  *
  * @param <TResult> the type of element signaled.
  * @see Observables
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public interface Observable<TResult> {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/Observables.java b/driver-async/src/main/com/mongodb/async/client/Observables.java
@@ -28,7 +28,9 @@
  * <p>Allows async methods to be converted into event-based {@link Observable}s.</p>
  *
  * @since 3.1
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public final class Observables {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/Observer.java b/driver-async/src/main/com/mongodb/async/client/Observer.java
@@ -36,7 +36,9 @@
  *
  * @param <TResult> The type of element signaled.
  * @since 3.1
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public interface Observer<TResult> {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/Subscription.java b/driver-async/src/main/com/mongodb/async/client/Subscription.java
@@ -26,7 +26,9 @@
  * </p>
  *
  * @since 3.1
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public interface Subscription {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/gridfs/AsyncInputStream.java b/driver-async/src/main/com/mongodb/async/client/gridfs/AsyncInputStream.java
@@ -25,7 +25,9 @@
  *
  * <p>See the {@link com.mongodb.async.client.gridfs.helpers} package for adapters that create an {@code AsyncInputStream}</p>
  * @since 3.3
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public interface AsyncInputStream {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/gridfs/AsyncOutputStream.java b/driver-async/src/main/com/mongodb/async/client/gridfs/AsyncOutputStream.java
@@ -26,7 +26,9 @@
  *
  * <p>See the {@link com.mongodb.async.client.gridfs.helpers} package for adapters that create an {@code AsyncOutputStream}</p>
  * @since 3.3
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public interface AsyncOutputStream {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/gridfs/GridFSBucket.java b/driver-async/src/main/com/mongodb/async/client/gridfs/GridFSBucket.java
@@ -32,8 +32,10 @@
  * Represents a GridFS Bucket
  *
  * @since 3.3
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
 @ThreadSafe
+@Deprecated
 public interface GridFSBucket {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/gridfs/GridFSBuckets.java b/driver-async/src/main/com/mongodb/async/client/gridfs/GridFSBuckets.java
@@ -22,7 +22,9 @@
  * A factory for GridFSBucket instances.
  *
  * @since 3.3
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public final class GridFSBuckets {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/gridfs/GridFSDownloadStream.java b/driver-async/src/main/com/mongodb/async/client/gridfs/GridFSDownloadStream.java
@@ -25,7 +25,9 @@
  * <p>Provides the {@code GridFSFile} for the file to being downloaded as well as the {@code read} methods of a {@link AsyncInputStream}</p>
  *
  * @since 3.3
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public interface GridFSDownloadStream extends AsyncInputStream {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/gridfs/GridFSFindIterable.java b/driver-async/src/main/com/mongodb/async/client/gridfs/GridFSFindIterable.java
@@ -28,7 +28,9 @@
  * Iterable for the GridFS Files Collection.
  *
  * @since 3.3
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public interface GridFSFindIterable extends MongoIterable<GridFSFile> {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/gridfs/GridFSUploadStream.java b/driver-async/src/main/com/mongodb/async/client/gridfs/GridFSUploadStream.java
@@ -26,7 +26,9 @@
  * <p>Provides the {@code id} for the file to be uploaded as well as the {@code write} methods of a {@link AsyncOutputStream}</p>
  *
  * @since 3.3
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public interface GridFSUploadStream extends AsyncOutputStream {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/gridfs/helpers/AsyncStreamHelper.java b/driver-async/src/main/com/mongodb/async/client/gridfs/helpers/AsyncStreamHelper.java
@@ -40,7 +40,9 @@
  * </ul>
  *
  * @since 3.3
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public final class AsyncStreamHelper {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/gridfs/helpers/AsynchronousChannelHelper.java b/driver-async/src/main/com/mongodb/async/client/gridfs/helpers/AsynchronousChannelHelper.java
@@ -34,7 +34,9 @@
  *
  * <p>Requires Java 7 or greater.</p>
  * @since 3.3
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public final class AsynchronousChannelHelper {
 
     /**
diff --git a/driver-async/src/main/com/mongodb/async/client/gridfs/helpers/package-info.java b/driver-async/src/main/com/mongodb/async/client/gridfs/helpers/package-info.java
@@ -18,4 +18,5 @@
  * Contains helper classes to create {@link com.mongodb.async.client.gridfs.AsyncInputStream} and
  * {@link com.mongodb.async.client.gridfs.AsyncOutputStream}'s from external sources.
  */
+@Deprecated
 package com.mongodb.async.client.gridfs.helpers;
diff --git a/driver-async/src/main/com/mongodb/async/client/gridfs/package-info.java b/driver-async/src/main/com/mongodb/async/client/gridfs/package-info.java
@@ -19,6 +19,7 @@
  * @mongodb.driver.manual core/gridfs/ GridFS
  */
 @NonNullApi
+@Deprecated
 package com.mongodb.async.client.gridfs;
 
 import com.mongodb.lang.NonNullApi;
diff --git a/driver-async/src/main/com/mongodb/async/client/package-info.java b/driver-async/src/main/com/mongodb/async/client/package-info.java
@@ -17,6 +17,7 @@
 /**
  * This packages contains classes for the new async client
  */
+@Deprecated
 @NonNullApi
 package com.mongodb.async.client;
 
diff --git a/driver-core/src/main/com/mongodb/async/AsyncBatchCursor.java b/driver-core/src/main/com/mongodb/async/AsyncBatchCursor.java
@@ -28,7 +28,9 @@
  *
  * @param <T> The type of documents the cursor contains
  * @mongodb.driver.manual ../meta-driver/latest/legacy/mongodb-wire-protocol/#wire-op-get-more OP_GET_MORE
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public interface AsyncBatchCursor<T> extends Closeable {
     /**
      * Returns the next batch of results.  A tailable cursor will block until another batch exists.  After the last batch, the next call
diff --git a/driver-core/src/main/com/mongodb/async/SingleResultCallback.java b/driver-core/src/main/com/mongodb/async/SingleResultCallback.java
@@ -21,7 +21,9 @@
  *
  * @param <T> the result type
  * @since 3.0
+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
  */
+@Deprecated
 public interface SingleResultCallback<T> {
     /**
      * Called when the operation completes.
diff --git a/driver-core/src/main/com/mongodb/async/package-info.java b/driver-core/src/main/com/mongodb/async/package-info.java
@@ -17,4 +17,5 @@
 /**
  * This package contains async interfaces
  */
+@Deprecated
 package com.mongodb.async;

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,9 @@`
`28`	`28`	`*`
`29`	`29`	`* @param <TResult> The type of the result.`
`30`	`30`	`* @since 3.0`
	`31`	`+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)`
`31`	`32`	`*/`
	`33`	`+@Deprecated`
`32`	`34`	`public interface AggregateIterable<TResult> extends MongoIterable<TResult> {`
`33`	`35`
`34`	`36`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,9 @@`
`26`	`26`	`*`
`27`	`27`	`* @param <TResult> The type of the result.`
`28`	`28`	`* @since 3.0`
	`29`	`+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)`
`29`	`30`	`*/`
	`31`	`+@Deprecated`
`30`	`32`	`public interface ListCollectionsIterable<TResult> extends MongoIterable<TResult> {`
`31`	`33`
`32`	`34`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,9 @@`
`25`	`25`	`* Iterable for ListDatabases.`
`26`	`26`	`*`
`27`	`27`	`* @param <T> The type of the result.`
	`28`	`+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)`
`28`	`29`	`*/`
	`30`	`+@Deprecated`
`29`	`31`	`public interface ListDatabasesIterable<T> extends MongoIterable<T> {`
`30`	`32`
`31`	`33`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,9 @@`
`23`	`23`	`*`
`24`	`24`	`* @param <TResult> The type of the result.`
`25`	`25`	`* @since 3.0`
	`26`	`+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)`
`26`	`27`	`*/`
	`28`	`+@Deprecated`
`27`	`29`	`public interface ListIndexesIterable<TResult> extends MongoIterable<TResult> {`
`28`	`30`
`29`	`31`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,9 @@`
`30`	`30`	`*`
`31`	`31`	`* @param <TResult> The type of the result.`
`32`	`32`	`* @since 3.0`
	`33`	`+ * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)`
`33`	`34`	`*/`
	`35`	`+@Deprecated`
`34`	`36`	`public interface MapReduceIterable<TResult> extends MongoIterable<TResult> {`
`35`	`37`
`36`	`38`	`/**`