Specify a pipeline to an update command

JAVA-3254

Author: jstewart148

config/checkstyle-exclude.xml

@@ -62,6 +62,7 @@
 
     <!--DBCollection is insanely long, and we should not compromise every class length for this one-->
     <suppress checks="FileLength" files="DBCollection"/>
+    <suppress checks="FileLength" files="MongoCollection"/>
 
     <suppress checks="ParameterNumber" files="Connection"/>
     <suppress checks="ParameterNumber" files="DefaultServer"/>

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

@@ -1237,6 +1237,84 @@ void replaceOne(ClientSession clientSession, Bson filter, TDocument replacement,
     void updateOne(ClientSession clientSession, Bson filter, Bson update, UpdateOptions options,
                    SingleResultCallback<UpdateResult> callback);
 
+    /**
+     * Update a single document in the collection according to the specified arguments.
+     *
+     * <p>Note: Supports retryable writes on MongoDB server versions 3.6 or higher when the retryWrites setting is enabled.</p>
+     * @param filter a document describing the query filter, which may not be null.
+     * @param update a pipeline describing the update, which may not be null.
+     * @param callback the callback passed the result of the update one operation
+     * @throws com.mongodb.MongoWriteException        if the write failed due some other failure specific to the update command
+     * @throws com.mongodb.MongoWriteConcernException if the write failed due being unable to fulfil the write concern
+     * @throws com.mongodb.MongoCommandException      via the callback if the write failed due to a specific command exception
+     * @throws com.mongodb.MongoException             if the write failed due some other failure
+     * @since 3.11
+     * @mongodb.server.release 4.2
+     * @mongodb.driver.manual tutorial/modify-documents/ Updates
+     * @mongodb.driver.manual reference/operator/update/ Update Operators
+     */
+    void updateOne(Bson filter, List<? extends Bson> update, SingleResultCallback<UpdateResult> callback);
+
+    /**
+     * Update a single document in the collection according to the specified arguments.
+     *
+     * <p>Note: Supports retryable writes on MongoDB server versions 3.6 or higher when the retryWrites setting is enabled.</p>
+     * @param filter        a document describing the query filter, which may not be null.
+     * @param update        a pipeline describing the update, which may not be null.
+     * @param updateOptions the options to apply to the update operation
+     * @param callback the callback passed the result of the update one operation
+     * @throws com.mongodb.MongoWriteException        if the write failed due some other failure specific to the update command
+     * @throws com.mongodb.MongoWriteConcernException if the write failed due being unable to fulfil the write concern
+     * @throws com.mongodb.MongoCommandException      via the callback if the write failed due to a specific command exception
+     * @throws com.mongodb.MongoException             if the write failed due some other failure
+     * @since 3.11
+     * @mongodb.server.release 4.2
+     * @mongodb.driver.manual tutorial/modify-documents/ Updates
+     * @mongodb.driver.manual reference/operator/update/ Update Operators
+     */
+    void updateOne(Bson filter, List<? extends Bson> update, UpdateOptions updateOptions,
+                           SingleResultCallback<UpdateResult> callback);
+
+    /**
+     * Update a single document in the collection according to the specified arguments.
+     *
+     * <p>Note: Supports retryable writes on MongoDB server versions 3.6 or higher when the retryWrites setting is enabled.</p>
+     * @param clientSession the client session with which to associate this operation
+     * @param filter a document describing the query filter, which may not be null.
+     * @param update a pipeline describing the update, which may not be null.
+     * @param callback the callback passed the result of the update one operation
+     * @throws com.mongodb.MongoWriteException        if the write failed due some other failure specific to the update command
+     * @throws com.mongodb.MongoWriteConcernException if the write failed due being unable to fulfil the write concern
+     * @throws com.mongodb.MongoCommandException      via the callback if the write failed due to a specific command exception
+     * @throws com.mongodb.MongoException             if the write failed due some other failure
+     * @since 3.11
+     * @mongodb.server.release 4.2
+     * @mongodb.driver.manual tutorial/modify-documents/ Updates
+     * @mongodb.driver.manual reference/operator/update/ Update Operators
+     */
+    void updateOne(ClientSession clientSession, Bson filter, List<? extends Bson> update, SingleResultCallback<UpdateResult> callback);
+
+    /**
+     * Update a single document in the collection according to the specified arguments.
+     *
+     * <p>Note: Supports retryable writes on MongoDB server versions 3.6 or higher when the retryWrites setting is enabled.</p>
+     * @param clientSession the client session with which to associate this operation
+     * @param filter        a document describing the query filter, which may not be null.
+     * @param update        a pipeline describing the update, which may not be null.
+     * @param updateOptions the options to apply to the update operation
+     * @param callback the callback passed the result of the update one operation
+     * @throws com.mongodb.MongoWriteException        if the write failed due some other failure specific to the update command
+     * @throws com.mongodb.MongoWriteConcernException if the write failed due being unable to fulfil the write concern
+     * @throws com.mongodb.MongoCommandException      via the callback if the write failed due to a specific command exception
+     * @throws com.mongodb.MongoException             if the write failed due some other failure
+     * @since 3.11
+     * @mongodb.server.release 4.2
+     * @mongodb.driver.manual tutorial/modify-documents/ Updates
+     * @mongodb.driver.manual reference/operator/update/ Update Operators
+     */
+    void updateOne(ClientSession clientSession, Bson filter, List<? extends Bson> update, UpdateOptions updateOptions,
+                   SingleResultCallback<UpdateResult> callback);
+
     /**
      * Update all documents in the collection according to the specified arguments.
      *
@@ -1306,6 +1384,75 @@ void updateOne(ClientSession clientSession, Bson filter, Bson update, UpdateOpti
     void updateMany(ClientSession clientSession, Bson filter, Bson update, UpdateOptions options,
                     SingleResultCallback<UpdateResult> callback);
 
+    /**
+     * Update all documents in the collection according to the specified arguments.
+     *
+     * @param filter a document describing the query filter, which may not be null.
+     * @param update a pipeline describing the update, which may not be null.
+     * @param callback the callback passed the result of the update many operation
+     * @throws com.mongodb.MongoWriteException        if the write failed due some other failure specific to the update command
+     * @throws com.mongodb.MongoWriteConcernException if the write failed due being unable to fulfil the write concern
+     * @throws com.mongodb.MongoException             if the write failed due some other failure
+     * @since 3.11
+     * @mongodb.server.release 4.2
+     * @mongodb.driver.manual tutorial/modify-documents/ Updates
+     * @mongodb.driver.manual reference/operator/update/ Update Operators
+     */
+    void updateMany(Bson filter, List<? extends Bson> update, SingleResultCallback<UpdateResult> callback);
+
+    /**
+     * Update all documents in the collection according to the specified arguments.
+     *
+     * @param filter        a document describing the query filter, which may not be null.
+     * @param update        a pipeline describing the update, which may not be null.
+     * @param updateOptions the options to apply to the update operation
+     * @param callback the callback passed the result of the update many operation
+     * @throws com.mongodb.MongoWriteException        if the write failed due some other failure specific to the update command
+     * @throws com.mongodb.MongoWriteConcernException if the write failed due being unable to fulfil the write concern
+     * @throws com.mongodb.MongoException             if the write failed due some other failure
+     * @since 3.11
+     * @mongodb.server.release 4.2
+     * @mongodb.driver.manual tutorial/modify-documents/ Updates
+     * @mongodb.driver.manual reference/operator/update/ Update Operators
+     */
+    void updateMany(Bson filter, List<? extends Bson> update, UpdateOptions updateOptions, SingleResultCallback<UpdateResult> callback);
+
+    /**
+     * Update all documents in the collection according to the specified arguments.
+     *
+     * @param clientSession the client session with which to associate this operation
+     * @param filter a document describing the query filter, which may not be null.
+     * @param update a pipeline describing the update, which may not be null.
+     * @param callback the callback passed the result of the update many operation
+     * @throws com.mongodb.MongoWriteException        if the write failed due some other failure specific to the update command
+     * @throws com.mongodb.MongoWriteConcernException if the write failed due being unable to fulfil the write concern
+     * @throws com.mongodb.MongoException             if the write failed due some other failure
+     * @since 3.11
+     * @mongodb.server.release 4.2
+     * @mongodb.driver.manual tutorial/modify-documents/ Updates
+     * @mongodb.driver.manual reference/operator/update/ Update Operators
+     */
+    void updateMany(ClientSession clientSession, Bson filter, List<? extends Bson> update, SingleResultCallback<UpdateResult> callback);
+
+    /**
+     * Update all documents in the collection according to the specified arguments.
+     *
+     * @param clientSession the client session with which to associate this operation
+     * @param filter        a document describing the query filter, which may not be null.
+     * @param update        a pipeline describing the update, which may not be null.
+     * @param updateOptions the options to apply to the update operation
+     * @param callback the callback passed the result of the update many operation
+     * @throws com.mongodb.MongoWriteException        if the write failed due some other failure specific to the update command
+     * @throws com.mongodb.MongoWriteConcernException if the write failed due being unable to fulfil the write concern
+     * @throws com.mongodb.MongoException             if the write failed due some other failure
+     * @since 3.11
+     * @mongodb.server.release 4.2
+     * @mongodb.driver.manual tutorial/modify-documents/ Updates
+     * @mongodb.driver.manual reference/operator/update/ Update Operators
+     */
+    void updateMany(ClientSession clientSession, Bson filter, List<? extends Bson> update, UpdateOptions updateOptions,
+                    SingleResultCallback<UpdateResult> callback);
+
     /**
      * Atomically find a document and remove it.
      *
@@ -1466,6 +1613,66 @@ void findOneAndReplace(ClientSession clientSession, Bson filter, TDocument repla
     void findOneAndUpdate(ClientSession clientSession, Bson filter, Bson update, FindOneAndUpdateOptions options,
                           SingleResultCallback<TDocument> callback);
 
+    /**
+     * Atomically find a document and update it.
+     *
+     * <p>Note: Supports retryable writes on MongoDB server versions 3.6 or higher when the retryWrites setting is enabled.</p>
+     * @param filter a document describing the query filter, which may not be null.
+     * @param update a pipeline describing the update, which may not be null.
+     * @param callback the callback passed the document that was updated before the update was applied.  If no documents matched the query
+     *                 filter, then null will be returned
+     * @since 3.11
+     * @mongodb.server.release 4.2
+     */
+    void findOneAndUpdate(Bson filter, List<? extends Bson> update, SingleResultCallback<TDocument> callback);
+
+    /**
+     * Atomically find a document and update it.
+     *
+     * <p>Note: Supports retryable writes on MongoDB server versions 3.6 or higher when the retryWrites setting is enabled.</p>
+     * @param filter  a document describing the query filter, which may not be null.
+     * @param update  a pipeline describing the update, which may not be null.
+     * @param options the options to apply to the operation
+     * @param callback the callback passed the document that was updated.  Depending on the value of the {@code returnOriginal} property,
+     *                 this will either be the document as it was before the update or as it is after the update.  If no documents matched
+     *                 the query filter, then null will be returned
+     * @since 3.11
+     * @mongodb.server.release 4.2
+     */
+    void findOneAndUpdate(Bson filter, List<? extends Bson> update, FindOneAndUpdateOptions options,
+                          SingleResultCallback<TDocument> callback);
+
+    /**
+     * Atomically find a document and update it.
+     *
+     * <p>Note: Supports retryable writes on MongoDB server versions 3.6 or higher when the retryWrites setting is enabled.</p>
+     * @param clientSession the client session with which to associate this operation
+     * @param filter a document describing the query filter, which may not be null.
+     * @param update a pipeline describing the update, which may not be null.
+     * @param callback the callback passed the document that was updated before the update was applied.  If no documents matched the query
+     *                 filter, then null will be returned
+     * @since 3.11
+     * @mongodb.server.release 4.2
+     */
+    void findOneAndUpdate(ClientSession clientSession, Bson filter, List<? extends Bson> update, SingleResultCallback<TDocument> callback);
+
+    /**
+     * Atomically find a document and update it.
+     *
+     * <p>Note: Supports retryable writes on MongoDB server versions 3.6 or higher when the retryWrites setting is enabled.</p>
+     * @param clientSession the client session with which to associate this operation
+     * @param filter  a document describing the query filter, which may not be null.
+     * @param update  a pipeline describing the update, which may not be null.
+     * @param options the options to apply to the operation
+     * @param callback the callback passed the document that was updated.  Depending on the value of the {@code returnOriginal} property,
+     *                 this will either be the document as it was before the update or as it is after the update.  If no documents matched
+     *                 the query filter, then null will be returned
+     * @since 3.11
+     * @mongodb.server.release 4.2
+     */
+    void findOneAndUpdate(ClientSession clientSession, Bson filter, List<? extends Bson> update, FindOneAndUpdateOptions options,
+                          SingleResultCallback<TDocument> callback);
+
     /**
      * Drops this collection from the Database.
      *