Added support for comment for operations

JAVA-4369

Author: rozza

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

@@ -17,6 +17,8 @@
 package com.mongodb.client.model;
 
 import com.mongodb.lang.Nullable;
+import org.bson.BsonString;
+import org.bson.BsonValue;
 
 /**
  * The options to apply to a bulk write.
@@ -26,6 +28,7 @@
 public final class BulkWriteOptions {
     private boolean ordered = true;
     private Boolean bypassDocumentValidation;
+    private BsonValue comment;
 
     /**
      * If true, then when a write fails, return without performing the remaining
@@ -76,11 +79,50 @@ public BulkWriteOptions bypassDocumentValidation(@Nullable final Boolean bypassD
         return this;
     }
 
+    /**
+     * Returns the comment to send with the query. The default is not to include a comment with the query.
+     *
+     * @return the comment
+     * @since 4.6
+     * @mongodb.server.release 4.4
+     */
+    @Nullable
+    public BsonValue getComment() {
+        return comment;
+    }
+
+    /**
+     * Sets the comment for this operation. A null value means no comment is set.
+     *
+     * @param comment the comment
+     * @return this
+     * @since 4.6
+     * @mongodb.server.release 4.4
+     */
+    public BulkWriteOptions comment(@Nullable final String comment) {
+        this.comment = comment != null ? new BsonString(comment) : null;
+        return this;
+    }
+
+    /**
+     * Sets the comment for this operation. A null value means no comment is set.
+     *
+     * @param comment the comment
+     * @return this
+     * @since 4.6
+     * @mongodb.server.release 4.4
+     */
+    public BulkWriteOptions comment(@Nullable final BsonValue comment) {
+        this.comment = comment;
+        return this;
+    }
+
     @Override
     public String toString() {
         return "BulkWriteOptions{"
                 + "ordered=" + ordered
                 + ", bypassDocumentValidation=" + bypassDocumentValidation
+                + ", comment=" + comment
                 + '}';
     }
 }

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

@@ -17,6 +17,8 @@
 package com.mongodb.client.model;
 
 import com.mongodb.lang.Nullable;
+import org.bson.BsonString;
+import org.bson.BsonValue;
 import org.bson.conversions.Bson;
 
 import java.util.concurrent.TimeUnit;
@@ -36,6 +38,7 @@ public class CountOptions {
     private int skip;
     private long maxTimeMS;
     private Collation collation;
+    private BsonValue comment;
 
     /**
      * Gets the hint to apply.
@@ -175,6 +178,42 @@ public CountOptions collation(@Nullable final Collation collation) {
         return this;
     }
 
+    /**
+     * @return the comment for this operation. A null value means no comment is set.
+     * @since 4.6
+     * @mongodb.server.release 4.4
+     */
+    @Nullable
+    public BsonValue getComment() {
+        return comment;
+    }
+
+    /**
+     * Sets the comment for this operation. A null value means no comment is set.
+     *
+     * @param comment the comment
+     * @return this
+     * @since 4.6
+     * @mongodb.server.release 4.4
+     */
+    public CountOptions comment(@Nullable final String comment) {
+        this.comment = comment == null ? null : new BsonString(comment);
+        return this;
+    }
+
+    /**
+     * Sets the comment for this operation. A null value means no comment is set.
+     *
+     * @param comment the comment
+     * @return this
+     * @since 4.6
+     * @mongodb.server.release 4.4
+     */
+    public CountOptions comment(@Nullable final BsonValue comment) {
+        this.comment = comment;
+        return this;
+    }
+
     @Override
     public String toString() {
         return "CountOptions{"
@@ -184,6 +223,7 @@ public String toString() {
                 + ", skip=" + skip
                 + ", maxTimeMS=" + maxTimeMS
                 + ", collation=" + collation
+                + ", comment=" + comment
                 + '}';
     }
 }

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

@@ -17,6 +17,8 @@
 package com.mongodb.client.model;
 
 import com.mongodb.lang.Nullable;
+import org.bson.BsonString;
+import org.bson.BsonValue;
 import org.bson.conversions.Bson;
 
 /**
@@ -30,6 +32,7 @@ public class DeleteOptions {
     private Bson hint;
     private String hintString;
     private Collation collation;
+    private BsonValue comment;
 
     /**
      * Returns the collation options
@@ -107,12 +110,53 @@ public DeleteOptions hintString(@Nullable final String hint) {
         return this;
     }
 
+    /**
+     * @return the comment for this operation. A null value means no comment is set.
+     * @since 4.6
+     * @mongodb.server.release 4.4
+     */
+    @Nullable
+    public BsonValue getComment() {
+        return comment;
+    }
+
+    /**
+     * Sets the comment for this operation. A null value means no comment is set.
+     *
+     * <p>For bulk operations use: {@link BulkWriteOptions#comment(String)}</p>
+     *
+     * @param comment the comment
+     * @return this
+     * @since 4.6
+     * @mongodb.server.release 4.4
+     */
+    public DeleteOptions comment(@Nullable final String comment) {
+        this.comment = comment != null ? new BsonString(comment) : null;
+        return this;
+    }
+
+    /**
+     * Sets the comment for this operation. A null value means no comment is set.
+     *
+     * <p>For bulk operations use: {@link BulkWriteOptions#comment(BsonValue)}</p>
+     *
+     * @param comment the comment
+     * @return this
+     * @since 4.6
+     * @mongodb.server.release 4.4
+     */
+    public DeleteOptions comment(@Nullable final BsonValue comment) {
+        this.comment = comment;
+        return this;
+    }
+
     @Override
     public String toString() {
         return "DeleteOptions{"
                 + "collation=" + collation
                 + ", hint=" + hint
                 + ", hintString='" + hintString + '\''
+                + ", comment=" + comment
                 + '}';
     }
 }

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

@@ -17,6 +17,8 @@
 package com.mongodb.client.model;
 
 import com.mongodb.lang.Nullable;
+import org.bson.BsonString;
+import org.bson.BsonValue;
 import org.bson.conversions.Bson;
 
 import java.util.concurrent.TimeUnit;
@@ -37,6 +39,7 @@ public class FindOneAndDeleteOptions {
     private Collation collation;
     private Bson hint;
     private String hintString;
+    private BsonValue comment;
 
     /**
      * Gets a document describing the fields to return for all matching documents.
@@ -186,6 +189,43 @@ public FindOneAndDeleteOptions hintString(@Nullable final String hint) {
         return this;
     }
 
+
+    /**
+     * @return the comment for this operation. A null value means no comment is set.
+     * @since 4.6
+     * @mongodb.server.release 4.4
+     */
+    @Nullable
+    public BsonValue getComment() {
+        return comment;
+    }
+
+    /**
+     * Sets the comment for this operation. A null value means no comment is set.
+     *
+     * @param comment the comment
+     * @return this
+     * @since 4.6
+     * @mongodb.server.release 4.4
+     */
+    public FindOneAndDeleteOptions comment(@Nullable final String comment) {
+        this.comment = comment != null ? new BsonString(comment) : null;
+        return this;
+    }
+
+    /**
+     * Sets the comment for this operation. A null value means no comment is set.
+     *
+     * @param comment the comment
+     * @return this
+     * @since 4.6
+     * @mongodb.server.release 4.4
+     */
+    public FindOneAndDeleteOptions comment(@Nullable final BsonValue comment) {
+        this.comment = comment;
+        return this;
+    }
+
     @Override
     public String toString() {
         return "FindOneAndDeleteOptions{"
@@ -195,6 +235,7 @@ public String toString() {
                 + ", collation=" + collation
                 + ", hint=" + hint
                 + ", hintString='" + hintString + '\''
+                + ", comment=" + comment
                 + '}';
     }
 }

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

@@ -17,6 +17,8 @@
 package com.mongodb.client.model;
 
 import com.mongodb.lang.Nullable;
+import org.bson.BsonString;
+import org.bson.BsonValue;
 import org.bson.conversions.Bson;
 
 import java.util.concurrent.TimeUnit;
@@ -40,6 +42,7 @@ public class FindOneAndReplaceOptions {
     private Collation collation;
     private Bson hint;
     private String hintString;
+    private BsonValue comment;
 
     /**
      * Gets a document describing the fields to return for all matching documents.
@@ -248,6 +251,43 @@ public FindOneAndReplaceOptions hintString(@Nullable final String hint) {
         return this;
     }
 
+
+    /**
+     * @return the comment for this operation. A null value means no comment is set.
+     * @since 4.6
+     * @mongodb.server.release 4.4
+     */
+    @Nullable
+    public BsonValue getComment() {
+        return comment;
+    }
+
+    /**
+     * Sets the comment for this operation. A null value means no comment is set.
+     *
+     * @param comment the comment
+     * @return this
+     * @since 4.6
+     * @mongodb.server.release 4.4
+     */
+    public FindOneAndReplaceOptions comment(@Nullable final String comment) {
+        this.comment = comment != null ? new BsonString(comment) : null;
+        return this;
+    }
+
+    /**
+     * Sets the comment for this operation. A null value means no comment is set.
+     *
+     * @param comment the comment
+     * @return this
+     * @since 4.6
+     * @mongodb.server.release 4.4
+     */
+    public FindOneAndReplaceOptions comment(@Nullable final BsonValue comment) {
+        this.comment = comment;
+        return this;
+    }
+
     @Override
     public String toString() {
         return "FindOneAndReplaceOptions{"
@@ -260,6 +300,7 @@ public String toString() {
                 + ", collation=" + collation
                 + ", hint=" + hint
                 + ", hintString" + hintString
+                + ", comment=" + comment
                 + '}';
     }
 }