Annotate com.mongodb.reactivestreams.client package as NonNullApi (#1015)

jyemin · web-flow · commit c86d174888a0 · 2022-10-11T09:59:26.000-04:00
JAVA-4765
diff --git a/driver-reactive-streams/src/main/com/mongodb/reactivestreams/client/MongoClients.java b/driver-reactive-streams/src/main/com/mongodb/reactivestreams/client/MongoClients.java
@@ -77,12 +77,13 @@ public static MongoClient create(final ConnectionString connectionString) {
      *
      * <p>Note: Intended for driver and library authors to associate extra driver metadata with the connections.</p>
      *
-     * @param connectionString the settings
+     * @param connectionString       the settings
      * @param mongoDriverInformation any driver information to associate with the MongoClient
      * @return the client
      * @since 1.3
      */
-    public static MongoClient create(final ConnectionString connectionString, final MongoDriverInformation mongoDriverInformation) {
+    public static MongoClient create(final ConnectionString connectionString,
+            @Nullable final MongoDriverInformation mongoDriverInformation) {
         return create(MongoClientSettings.builder().applyConnectionString(connectionString).build(), mongoDriverInformation);
     }
 
@@ -102,12 +103,12 @@ public static MongoClient create(final MongoClientSettings settings) {
      *
      * <p>Note: Intended for driver and library authors to associate extra driver metadata with the connections.</p>
      *
-     * @param settings the settings
+     * @param settings               the settings
      * @param mongoDriverInformation any driver information to associate with the MongoClient
      * @return the client
      * @since 1.8
      */
-    public static MongoClient create(final MongoClientSettings settings, final MongoDriverInformation mongoDriverInformation) {
+    public static MongoClient create(final MongoClientSettings settings, @Nullable final MongoDriverInformation mongoDriverInformation) {
         if (settings.getStreamFactoryFactory() == null) {
             if (settings.getSslSettings().isEnabled()) {
                 return createWithTlsChannel(settings, mongoDriverInformation);
@@ -151,7 +152,7 @@ private static Cluster createCluster(final MongoClientSettings settings,
                 settings.getCompressorList(), settings.getServerApi());
     }
 
-    private static MongoDriverInformation wrapMongoDriverInformation(final MongoDriverInformation mongoDriverInformation) {
+    private static MongoDriverInformation wrapMongoDriverInformation(@Nullable final MongoDriverInformation mongoDriverInformation) {
         return (mongoDriverInformation == null ? MongoDriverInformation.builder() : MongoDriverInformation.builder(mongoDriverInformation))
                 .driverName("reactive-streams").build();
     }
diff --git a/driver-reactive-streams/src/main/com/mongodb/reactivestreams/client/package-info.java b/driver-reactive-streams/src/main/com/mongodb/reactivestreams/client/package-info.java
@@ -28,4 +28,8 @@
  * Each {@link org.reactivestreams.Subscription} to a {@link org.reactivestreams.Publisher} relates to a single MongoDB operation and its
  * {@link org.reactivestreams.Subscriber} will receive its own specific set of results.
  */
+
+@NonNullApi
 package com.mongodb.reactivestreams.client;
+
+import com.mongodb.lang.NonNullApi;
diff --git a/driver-reactive-streams/src/test/functional/com/mongodb/reactivestreams/client/ClientSideEncryptionAwsCredentialFromEnvironmentTest.java b/driver-reactive-streams/src/test/functional/com/mongodb/reactivestreams/client/ClientSideEncryptionAwsCredentialFromEnvironmentTest.java
@@ -21,21 +21,18 @@
 import com.mongodb.client.AbstractClientSideEncryptionAwsCredentialFromEnvironmentTest;
 import com.mongodb.client.MongoClient;
 import com.mongodb.client.vault.ClientEncryption;
-import com.mongodb.lang.NonNull;
 import com.mongodb.reactivestreams.client.syncadapter.SyncClientEncryption;
 import com.mongodb.reactivestreams.client.syncadapter.SyncMongoClient;
 import com.mongodb.reactivestreams.client.vault.ClientEncryptions;
 
 public class ClientSideEncryptionAwsCredentialFromEnvironmentTest extends AbstractClientSideEncryptionAwsCredentialFromEnvironmentTest {
     @Override
-    @NonNull
-    protected ClientEncryption createClientEncryption(@NonNull final ClientEncryptionSettings settings) {
+    protected ClientEncryption createClientEncryption(final ClientEncryptionSettings settings) {
         return new SyncClientEncryption(ClientEncryptions.create(settings));
     }
 
     @Override
-    @NonNull
-    protected MongoClient createMongoClient(@NonNull final MongoClientSettings settings) {
+    protected MongoClient createMongoClient(final MongoClientSettings settings) {
         return new SyncMongoClient(MongoClients.create(settings));
     }
 }
diff --git a/driver-reactive-streams/src/test/functional/com/mongodb/reactivestreams/client/ClientSideEncryptionDeadlockTest.java b/driver-reactive-streams/src/test/functional/com/mongodb/reactivestreams/client/ClientSideEncryptionDeadlockTest.java
@@ -21,13 +21,11 @@
 import com.mongodb.MongoClientSettings;
 import com.mongodb.client.AbstractClientSideEncryptionDeadlockTest;
 import com.mongodb.client.MongoClient;
-import com.mongodb.lang.NonNull;
 import com.mongodb.reactivestreams.client.syncadapter.SyncMongoClient;
 
 public class ClientSideEncryptionDeadlockTest extends AbstractClientSideEncryptionDeadlockTest {
     @Override
-    @NonNull
-    protected MongoClient createMongoClient(@NonNull final MongoClientSettings settings) {
+    protected MongoClient createMongoClient(final MongoClientSettings settings) {
         return new SyncMongoClient(MongoClients.create(settings));
     }
 }
diff --git a/driver-reactive-streams/src/test/functional/com/mongodb/reactivestreams/client/ClientSideEncryptionOnDemandGcpCredentialsTest.java b/driver-reactive-streams/src/test/functional/com/mongodb/reactivestreams/client/ClientSideEncryptionOnDemandGcpCredentialsTest.java
@@ -19,15 +19,13 @@
 import com.mongodb.ClientEncryptionSettings;
 import com.mongodb.client.AbstractClientSideEncryptionOnDemandGcpCredentialsTest;
 import com.mongodb.client.vault.ClientEncryption;
-import com.mongodb.lang.NonNull;
 import com.mongodb.reactivestreams.client.syncadapter.SyncClientEncryption;
 import com.mongodb.reactivestreams.client.vault.ClientEncryptions;
 
 public class ClientSideEncryptionOnDemandGcpCredentialsTest extends AbstractClientSideEncryptionOnDemandGcpCredentialsTest {
 
-    @NonNull
     @Override
-    public ClientEncryption getClientEncryption(@NonNull final ClientEncryptionSettings settings) {
+    public ClientEncryption getClientEncryption(final ClientEncryptionSettings settings) {
         return new SyncClientEncryption(ClientEncryptions.create(settings));
     }
 }
diff --git a/driver-reactive-streams/src/test/functional/com/mongodb/reactivestreams/client/ExplainTest.java b/driver-reactive-streams/src/test/functional/com/mongodb/reactivestreams/client/ExplainTest.java
@@ -19,13 +19,11 @@
 import com.mongodb.MongoClientSettings;
 import com.mongodb.client.AbstractExplainTest;
 import com.mongodb.client.MongoClient;
-import com.mongodb.lang.NonNull;
 import com.mongodb.reactivestreams.client.syncadapter.SyncMongoClient;
 
 public class ExplainTest extends AbstractExplainTest {
     @Override
-    @NonNull
-    protected MongoClient createMongoClient(@NonNull final MongoClientSettings settings) {
+    protected MongoClient createMongoClient(final MongoClientSettings settings) {
         return new SyncMongoClient(MongoClients.create(settings));
     }
 }
diff --git a/driver-reactive-streams/src/test/functional/com/mongodb/reactivestreams/client/ReactiveInitialDnsSeedlistDiscoveryTest.java b/driver-reactive-streams/src/test/functional/com/mongodb/reactivestreams/client/ReactiveInitialDnsSeedlistDiscoveryTest.java
@@ -19,7 +19,6 @@
 import com.mongodb.MongoClientSettings;
 import com.mongodb.client.InitialDnsSeedlistDiscoveryTest;
 import com.mongodb.client.MongoClient;
-import com.mongodb.lang.NonNull;
 import com.mongodb.reactivestreams.client.syncadapter.SyncMongoClient;
 import org.bson.BsonDocument;
 import org.junit.runner.RunWith;
@@ -40,7 +39,7 @@ public ReactiveInitialDnsSeedlistDiscoveryTest(final String filename, final Path
     }
 
     @Override
-    public MongoClient createMongoClient(@NonNull final MongoClientSettings settings) {
+    public MongoClient createMongoClient(final MongoClientSettings settings) {
         return new SyncMongoClient(MongoClients.create(settings));
     }
 }
diff --git a/driver-sync/src/test/functional/com/mongodb/client/AbstractClientEncryptionCustomEndpointTest.java b/driver-sync/src/test/functional/com/mongodb/client/AbstractClientEncryptionCustomEndpointTest.java
@@ -22,7 +22,6 @@
 import com.mongodb.client.model.vault.EncryptOptions;
 import com.mongodb.client.vault.ClientEncryption;
 import com.mongodb.crypt.capi.MongoCryptException;
-import com.mongodb.lang.NonNull;
 import com.mongodb.lang.Nullable;
 import org.bson.BsonBinary;
 import org.bson.BsonDocument;
@@ -150,7 +149,6 @@ public void after() {
         }
     }
 
-    @NonNull
     public abstract ClientEncryption getClientEncryption(ClientEncryptionSettings settings);
 
     @Test
diff --git a/driver-sync/src/test/functional/com/mongodb/client/AbstractClientSideEncryptionOnDemandGcpCredentialsTest.java b/driver-sync/src/test/functional/com/mongodb/client/AbstractClientSideEncryptionOnDemandGcpCredentialsTest.java
@@ -36,7 +36,6 @@
 
 public abstract class AbstractClientSideEncryptionOnDemandGcpCredentialsTest {
 
-    @NonNull
     public abstract ClientEncryption getClientEncryption(ClientEncryptionSettings settings);
 
     private ClientEncryption clientEncryption;
diff --git a/driver-sync/src/test/functional/com/mongodb/client/ClientSideEncryptionOnDemandGcpCredentialsTest.java b/driver-sync/src/test/functional/com/mongodb/client/ClientSideEncryptionOnDemandGcpCredentialsTest.java
@@ -19,11 +19,9 @@
 import com.mongodb.ClientEncryptionSettings;
 import com.mongodb.client.vault.ClientEncryption;
 import com.mongodb.client.vault.ClientEncryptions;
-import com.mongodb.lang.NonNull;
 
 public class ClientSideEncryptionOnDemandGcpCredentialsTest extends AbstractClientSideEncryptionOnDemandGcpCredentialsTest {
 
-    @NonNull
     @Override
     public ClientEncryption getClientEncryption(final ClientEncryptionSettings settings) {
         return ClientEncryptions.create(settings);

Original file line number	Diff line number	Diff line change
`@@ -77,12 +77,13 @@ public static MongoClient create(final ConnectionString connectionString) {`
`77`	`77`	`*`
`78`	`78`	`* <p>Note: Intended for driver and library authors to associate extra driver metadata with the connections.</p>`
`79`	`79`	`*`
`80`		`- * @param connectionString the settings`
	`80`	`+ * @param connectionString the settings`
`81`	`81`	`* @param mongoDriverInformation any driver information to associate with the MongoClient`
`82`	`82`	`* @return the client`
`83`	`83`	`* @since 1.3`
`84`	`84`	`*/`
`85`		`- public static MongoClient create(final ConnectionString connectionString, final MongoDriverInformation mongoDriverInformation) {`
	`85`	`+ public static MongoClient create(final ConnectionString connectionString,`
	`86`	`+ @Nullable final MongoDriverInformation mongoDriverInformation) {`
`86`	`87`	`return create(MongoClientSettings.builder().applyConnectionString(connectionString).build(), mongoDriverInformation);`
`87`	`88`	`}`
`88`	`89`
`@@ -102,12 +103,12 @@ public static MongoClient create(final MongoClientSettings settings) {`
`102`	`103`	`*`
`103`	`104`	`* <p>Note: Intended for driver and library authors to associate extra driver metadata with the connections.</p>`
`104`	`105`	`*`
`105`		`- * @param settings the settings`
	`106`	`+ * @param settings the settings`
`106`	`107`	`* @param mongoDriverInformation any driver information to associate with the MongoClient`
`107`	`108`	`* @return the client`
`108`	`109`	`* @since 1.8`
`109`	`110`	`*/`
`110`		`- public static MongoClient create(final MongoClientSettings settings, final MongoDriverInformation mongoDriverInformation) {`
	`111`	`+ public static MongoClient create(final MongoClientSettings settings, @Nullable final MongoDriverInformation mongoDriverInformation) {`
`111`	`112`	`if (settings.getStreamFactoryFactory() == null) {`
`112`	`113`	`if (settings.getSslSettings().isEnabled()) {`
`113`	`114`	`return createWithTlsChannel(settings, mongoDriverInformation);`
`@@ -151,7 +152,7 @@ private static Cluster createCluster(final MongoClientSettings settings,`
`151`	`152`	`settings.getCompressorList(), settings.getServerApi());`
`152`	`153`	`}`
`153`	`154`
`154`		`- private static MongoDriverInformation wrapMongoDriverInformation(final MongoDriverInformation mongoDriverInformation) {`
	`155`	`+ private static MongoDriverInformation wrapMongoDriverInformation(@Nullable final MongoDriverInformation mongoDriverInformation) {`
`155`	`156`	`return (mongoDriverInformation == null ? MongoDriverInformation.builder() : MongoDriverInformation.builder(mongoDriverInformation))`
`156`	`157`	`.driverName("reactive-streams").build();`
`157`	`158`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,13 +21,11 @@`
`21`	`21`	`import com.mongodb.MongoClientSettings;`
`22`	`22`	`import com.mongodb.client.AbstractClientSideEncryptionDeadlockTest;`
`23`	`23`	`import com.mongodb.client.MongoClient;`
`24`		`-import com.mongodb.lang.NonNull;`
`25`	`24`	`import com.mongodb.reactivestreams.client.syncadapter.SyncMongoClient;`
`26`	`25`
`27`	`26`	`public class ClientSideEncryptionDeadlockTest extends AbstractClientSideEncryptionDeadlockTest {`
`28`	`27`	`@Override`
`29`		`- @NonNull`
`30`		`- protected MongoClient createMongoClient(@NonNull final MongoClientSettings settings) {`
	`28`	`+ protected MongoClient createMongoClient(final MongoClientSettings settings) {`
`31`	`29`	`return new SyncMongoClient(MongoClients.create(settings));`
`32`	`30`	`}`
`33`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,13 +19,11 @@`
`19`	`19`	`import com.mongodb.MongoClientSettings;`
`20`	`20`	`import com.mongodb.client.AbstractExplainTest;`
`21`	`21`	`import com.mongodb.client.MongoClient;`
`22`		`-import com.mongodb.lang.NonNull;`
`23`	`22`	`import com.mongodb.reactivestreams.client.syncadapter.SyncMongoClient;`
`24`	`23`
`25`	`24`	`public class ExplainTest extends AbstractExplainTest {`
`26`	`25`	`@Override`
`27`		`- @NonNull`
`28`		`- protected MongoClient createMongoClient(@NonNull final MongoClientSettings settings) {`
	`26`	`+ protected MongoClient createMongoClient(final MongoClientSettings settings) {`
`29`	`27`	`return new SyncMongoClient(MongoClients.create(settings));`
`30`	`28`	`}`
`31`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,6 @@`
`19`	`19`	`import com.mongodb.MongoClientSettings;`
`20`	`20`	`import com.mongodb.client.InitialDnsSeedlistDiscoveryTest;`
`21`	`21`	`import com.mongodb.client.MongoClient;`
`22`		`-import com.mongodb.lang.NonNull;`
`23`	`22`	`import com.mongodb.reactivestreams.client.syncadapter.SyncMongoClient;`
`24`	`23`	`import org.bson.BsonDocument;`
`25`	`24`	`import org.junit.runner.RunWith;`
`@@ -40,7 +39,7 @@ public ReactiveInitialDnsSeedlistDiscoveryTest(final String filename, final Path`
`40`	`39`	`}`
`41`	`40`
`42`	`41`	`@Override`
`43`		`- public MongoClient createMongoClient(@NonNull final MongoClientSettings settings) {`
	`42`	`+ public MongoClient createMongoClient(final MongoClientSettings settings) {`
`44`	`43`	`return new SyncMongoClient(MongoClients.create(settings));`
`45`	`44`	`}`
`46`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,6 @@`
`22`	`22`	`import com.mongodb.client.model.vault.EncryptOptions;`
`23`	`23`	`import com.mongodb.client.vault.ClientEncryption;`
`24`	`24`	`import com.mongodb.crypt.capi.MongoCryptException;`
`25`		`-import com.mongodb.lang.NonNull;`
`26`	`25`	`import com.mongodb.lang.Nullable;`
`27`	`26`	`import org.bson.BsonBinary;`
`28`	`27`	`import org.bson.BsonDocument;`
`@@ -150,7 +149,6 @@ public void after() {`
`150`	`149`	`}`
`151`	`150`	`}`
`152`	`151`
`153`		`- @NonNull`
`154`	`152`	`public abstract ClientEncryption getClientEncryption(ClientEncryptionSettings settings);`
`155`	`153`
`156`	`154`	`@Test`