JAVA-2641: Make com.mongodb.client packages a NonNullApi and add Nullable annotations to methods and parameters that require it

Author: jyemin

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

@@ -277,12 +277,14 @@ private void executeCreateCollection(@Nullable final ClientSession clientSession
                 .collation(options.getCollation());
 
         IndexOptionDefaults indexOptionDefaults = options.getIndexOptionDefaults();
-        if (indexOptionDefaults.getStorageEngine() != null) {
-            operation.indexOptionDefaults(new BsonDocument("storageEngine", toBsonDocument(indexOptionDefaults.getStorageEngine())));
+        Bson storageEngine = indexOptionDefaults.getStorageEngine();
+        if (storageEngine != null) {
+            operation.indexOptionDefaults(new BsonDocument("storageEngine", toBsonDocument(storageEngine)));
         }
         ValidationOptions validationOptions = options.getValidationOptions();
-        if (validationOptions.getValidator() != null) {
-            operation.validator(toBsonDocument(validationOptions.getValidator()));
+        Bson validator = validationOptions.getValidator();
+        if (validator != null) {
+            operation.validator(toBsonDocument(validator));
         }
         if (validationOptions.getValidationLevel() != null) {
             operation.validationLevel(validationOptions.getValidationLevel());

driver-async/src/main/com/mongodb/async/client/gridfs/GridFSBucketImpl.java

@@ -176,7 +176,8 @@ public GridFSUploadStream openUploadStream(final ClientSession clientSession, fi
     private GridFSUploadStream createGridFSUploadStream(@Nullable final ClientSession clientSession, final BsonValue id,
                                                         final String filename, final GridFSUploadOptions options) {
         notNull("options", options);
-        int chunkSize = options.getChunkSizeBytes() == null ? chunkSizeBytes : options.getChunkSizeBytes();
+        Integer chunkSizeBytes = options.getChunkSizeBytes();
+        int chunkSize = chunkSizeBytes == null ? this.chunkSizeBytes : chunkSizeBytes;
         return new GridFSUploadStreamImpl(clientSession, filesCollection, chunksCollection, id, filename, chunkSize, options.getMetadata(),
                 new GridFSIndexCheckImpl(clientSession, filesCollection, chunksCollection));
     }
@@ -257,7 +258,8 @@ private void executeUploadFromStream(@Nullable final ClientSession clientSession
         notNull("source", source);
         notNull("options", options);
         notNull("callback", callback);
-        int chunkSize = options.getChunkSizeBytes() == null ? chunkSizeBytes : options.getChunkSizeBytes();
+        Integer chunkSizeBytes = options.getChunkSizeBytes();
+        int chunkSize = chunkSizeBytes == null ? this.chunkSizeBytes : chunkSizeBytes;
         GridFSUploadStream uploadStream;
         if (clientSession != null){
             uploadStream = openUploadStream(clientSession, id, filename, options);

driver-async/src/main/com/mongodb/async/client/gridfs/GridFSUploadStreamImpl.java

@@ -68,7 +68,7 @@ final class GridFSUploadStreamImpl implements GridFSUploadStream {
 
     GridFSUploadStreamImpl(@Nullable final ClientSession clientSession, final MongoCollection<GridFSFile> filesCollection,
                            final MongoCollection<Document> chunksCollection, final BsonValue fileId, final String filename,
-                           final int chunkSizeBytes, final Document metadata, final GridFSIndexCheck indexCheck) {
+                           final int chunkSizeBytes, @Nullable final Document metadata, final GridFSIndexCheck indexCheck) {
         this.clientSession = clientSession;
         this.filesCollection = notNull("files collection", filesCollection);
         this.chunksCollection = notNull("chunks collection", chunksCollection);

driver-core/src/main/com/mongodb/client/gridfs/codecs/GridFSFileCodec.java

@@ -17,6 +17,7 @@
 package com.mongodb.client.gridfs.codecs;
 
 import com.mongodb.client.gridfs.model.GridFSFile;
+import com.mongodb.lang.Nullable;
 import org.bson.BsonDateTime;
 import org.bson.BsonDocument;
 import org.bson.BsonDocumentReader;
@@ -111,6 +112,7 @@ public Class<GridFSFile> getEncoderClass() {
         return GridFSFile.class;
     }
 
+    @Nullable
     private Document asDocumentOrNull(final BsonDocument bsonDocument) {
         if (bsonDocument.isEmpty()) {
             return null;

driver-core/src/main/com/mongodb/client/gridfs/codecs/package-info.java

@@ -19,4 +19,7 @@
  *
  * @since 3.3
  */
+@NonNullApi
 package com.mongodb.client.gridfs.codecs;
+
+import com.mongodb.lang.NonNullApi;

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

@@ -17,6 +17,7 @@
 package com.mongodb.client.gridfs.model;
 
 import com.mongodb.MongoGridFSException;
+import com.mongodb.lang.Nullable;
 import org.bson.BsonValue;
 import org.bson.Document;
 import org.bson.types.ObjectId;
@@ -76,7 +77,7 @@ public GridFSFile(final BsonValue id, final String filename, final long length,
      * @param extraElements any extra data stored in the document
      */
     public GridFSFile(final BsonValue id, final String filename, final long length, final int chunkSize, final Date uploadDate,
-                      final String md5, final Document metadata, final Document extraElements) {
+                      final String md5, @Nullable final Document metadata, @Nullable final Document extraElements) {
         this.id = notNull("id", id);
         this.filename = notNull("filename", filename);
         this.length = notNull("length", length);
@@ -160,6 +161,7 @@ public String getMD5() {
      *
      * @return the metadata document or null
      */
+    @Nullable
     public Document getMetadata() {
         return metadata;
     }
@@ -171,6 +173,7 @@ public Document getMetadata() {
      * @deprecated any extra information should be stored in the metadata document instead.
      */
     @Deprecated
+    @Nullable
     public Document getExtraElements() {
         return extraElements;
     }

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

@@ -16,6 +16,7 @@
 
 package com.mongodb.client.gridfs.model;
 
+import com.mongodb.lang.Nullable;
 import org.bson.Document;
 
 /**
@@ -42,6 +43,7 @@ public GridFSUploadOptions() {
      *
      * @return number of bytes per chunk if set or null
      */
+    @Nullable
     public Integer getChunkSizeBytes() {
         return chunkSizeBytes;
     }
@@ -52,7 +54,7 @@ public Integer getChunkSizeBytes() {
      * @param chunkSizeBytes the number of bytes per chunk for the uploaded file
      * @return this
      */
-    public GridFSUploadOptions chunkSizeBytes(final Integer chunkSizeBytes) {
+    public GridFSUploadOptions chunkSizeBytes(@Nullable final Integer chunkSizeBytes) {
         this.chunkSizeBytes = chunkSizeBytes;
         return this;
     }
@@ -62,6 +64,7 @@ public GridFSUploadOptions chunkSizeBytes(final Integer chunkSizeBytes) {
      *
      * @return the user provided metadata for the file if set or null
      */
+    @Nullable
     public Document getMetadata() {
         return metadata;
     }
@@ -72,7 +75,7 @@ public Document getMetadata() {
      * @param metadata the metadata to be stored
      * @return this
      */
-    public GridFSUploadOptions metadata(final Document metadata) {
+    public GridFSUploadOptions metadata(@Nullable final Document metadata) {
         this.metadata = metadata;
         return this;
     }

driver-core/src/main/com/mongodb/client/gridfs/model/package-info.java

@@ -19,4 +19,7 @@
  *
  * @since 3.1
  */
+@NonNullApi
 package com.mongodb.client.gridfs.model;
+
+import com.mongodb.lang.NonNullApi;

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

@@ -16,6 +16,7 @@
 
 package com.mongodb.client.model;
 
+import com.mongodb.lang.Nullable;
 import org.bson.BsonBoolean;
 import org.bson.BsonDocument;
 import org.bson.BsonDocumentWriter;
@@ -274,7 +275,8 @@ public static Bson lookup(final String from, final List<? extends Bson> pipeline
      * @mongodb.server.release 3.6
      * @since 3.7
      */
-    public static Bson lookup(final String from, final List<Variable<?>> let, final List<? extends Bson> pipeline, final String as) {
+    public static Bson lookup(final String from, @Nullable final List<Variable<?>> let, final List<? extends Bson> pipeline,
+                              final String as) {
        return new LookupStage(from, let, pipeline, as);
     }
 
@@ -396,11 +398,13 @@ public static Bson unwind(final String fieldName) {
     public static Bson unwind(final String fieldName, final UnwindOptions unwindOptions) {
         notNull("unwindOptions", unwindOptions);
         BsonDocument options = new BsonDocument("path", new BsonString(fieldName));
-        if (unwindOptions.isPreserveNullAndEmptyArrays() != null) {
-            options.append("preserveNullAndEmptyArrays", BsonBoolean.valueOf(unwindOptions.isPreserveNullAndEmptyArrays()));
+        Boolean preserveNullAndEmptyArrays = unwindOptions.isPreserveNullAndEmptyArrays();
+        if (preserveNullAndEmptyArrays != null) {
+            options.append("preserveNullAndEmptyArrays", BsonBoolean.valueOf(preserveNullAndEmptyArrays));
         }
-        if (unwindOptions.getIncludeArrayIndex() != null) {
-            options.append("includeArrayIndex", new BsonString(unwindOptions.getIncludeArrayIndex()));
+        String includeArrayIndex = unwindOptions.getIncludeArrayIndex();
+        if (includeArrayIndex != null) {
+            options.append("includeArrayIndex", new BsonString(includeArrayIndex));
         }
         return new BsonDocument("$unwind", options);
     }
@@ -444,7 +448,8 @@ public static Bson sample(final int size) {
         return new BsonDocument("$sample", new BsonDocument("size", new BsonInt32(size)));
     }
 
-    static void writeBucketOutput(final CodecRegistry codecRegistry, final BsonDocumentWriter writer, final List<BsonField> output) {
+    static void writeBucketOutput(final CodecRegistry codecRegistry, final BsonDocumentWriter writer,
+                                  @Nullable final List<BsonField> output) {
         if (output != null) {
             writer.writeName("output");
             writer.writeStartDocument();
@@ -508,9 +513,10 @@ public <TDocument> BsonDocument toBsonDocument(final Class<TDocument> tDocumentC
                 BuildersHelper.encodeValue(writer, boundary, codecRegistry);
             }
             writer.writeEndArray();
-            if (options.getDefaultBucket() != null) {
+            Object defaultBucket = options.getDefaultBucket();
+            if (defaultBucket != null) {
                 writer.writeName("default");
-                BuildersHelper.encodeValue(writer, options.getDefaultBucket(), codecRegistry);
+                BuildersHelper.encodeValue(writer, defaultBucket, codecRegistry);
             }
             writeBucketOutput(codecRegistry, writer, options.getOutput());
             writer.writeEndDocument();
@@ -557,8 +563,9 @@ public <TDocument> BsonDocument toBsonDocument(final Class<TDocument> tDocumentC
 
             writeBucketOutput(codecRegistry, writer, options.getOutput());
 
-            if (options.getGranularity() != null) {
-                writer.writeString("granularity", options.getGranularity().getValue());
+            BucketGranularity granularity = options.getGranularity();
+            if (granularity != null) {
+                writer.writeString("granularity", granularity.getValue());
             }
             writer.writeEndDocument();
 
@@ -582,7 +589,8 @@ private static final class LookupStage implements Bson {
         private final List<? extends Bson> pipeline;
         private final String as;
 
-        private LookupStage(final String from, final List<Variable<?>> let, final List<? extends Bson> pipeline, final String as) {
+        private LookupStage(final String from, @Nullable final List<Variable<?>> let, final List<? extends Bson> pipeline,
+                            final String as) {
             this.from = from;
             this.let = let;
             this.pipeline = pipeline;
@@ -672,15 +680,18 @@ public <TDocument> BsonDocument toBsonDocument(final Class<TDocument> tDocumentC
             writer.writeString("connectFromField", connectFromField);
             writer.writeString("connectToField", connectToField);
             writer.writeString("as", as);
-            if (options.getMaxDepth() != null) {
-                writer.writeInt32("maxDepth", options.getMaxDepth());
+            Integer maxDepth = options.getMaxDepth();
+            if (maxDepth != null) {
+                writer.writeInt32("maxDepth", maxDepth);
             }
-            if (options.getDepthField() != null) {
-                writer.writeString("depthField", options.getDepthField());
+            String depthField = options.getDepthField();
+            if (depthField != null) {
+                writer.writeString("depthField", depthField);
             }
-            if (options.getRestrictSearchWithMatch() != null) {
+            Bson restrictSearchWithMatch = options.getRestrictSearchWithMatch();
+            if (restrictSearchWithMatch != null) {
                 writer.writeName("restrictSearchWithMatch");
-                BuildersHelper.encodeValue(writer, options.getRestrictSearchWithMatch(), codecRegistry);
+                BuildersHelper.encodeValue(writer, restrictSearchWithMatch, codecRegistry);
             }
 
             writer.writeEndDocument();

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

@@ -16,6 +16,8 @@
 
 package com.mongodb.client.model;
 
+import com.mongodb.lang.Nullable;
+
 import java.util.ArrayList;
 import java.util.List;
 
@@ -35,13 +37,15 @@ public class BucketAutoOptions {
     /**
      * @return the granularity of the bucket definitions
      */
+    @Nullable
     public BucketGranularity getGranularity() {
         return granularity;
     }
 
     /**
      * @return the output document definition
      */
+    @Nullable
     public List<BsonField> getOutput() {
         return output == null ? null : new ArrayList<BsonField>(output);
     }
@@ -54,7 +58,7 @@ public List<BsonField> getOutput() {
      * @see <a href="https://en.wikipedia.org/wiki/Preferred_number">Preferred numbers</a>
      * @see BucketGranularity
      */
-    public BucketAutoOptions granularity(final BucketGranularity granularity) {
+    public BucketAutoOptions granularity(@Nullable final BucketGranularity granularity) {
         this.granularity = granularity;
         return this;
     }
@@ -76,7 +80,7 @@ public BucketAutoOptions output(final BsonField... output) {
      * @param output the output document definition
      * @return this
      */
-    public BucketAutoOptions output(final List<BsonField> output) {
+    public BucketAutoOptions output(@Nullable final List<BsonField> output) {
         this.output = output;
         return this;
     }