Create and document Java sync improved bulk write API

driver-core/src/main/com/mongodb/ClientBulkWriteException.java

@@ -16,8 +16,8 @@
 package com.mongodb;
 
 import com.mongodb.bulk.WriteConcernError;
-import com.mongodb.client.model.bulk.ClientWriteModel;
 import com.mongodb.client.model.bulk.ClientBulkWriteResult;
+import com.mongodb.client.model.bulk.ClientNamespacedWriteModel;
 import com.mongodb.lang.Nullable;
 
 import java.util.List;
@@ -112,7 +112,7 @@ public List<WriteConcernError> getWriteConcernErrors() {
 
     /**
      * The indexed {@link WriteError}s.
-     * The {@linkplain Map#keySet() keys} are the indexes of the corresponding {@link ClientWriteModel}s
+     * The {@linkplain Map#keySet() keys} are the indexes of the corresponding {@link ClientNamespacedWriteModel}s
      * in the corresponding client-level bulk write operation.
      * <p>
      * There are no guarantees on mutability or iteration order of the {@link Map} returned.</p>
@@ -130,7 +130,7 @@ public Map<Integer, WriteError> getWriteErrors() {
      * The result of the successful part of a client-level bulk write operation.
      *
      * @return The successful partial result. {@linkplain Optional#isPresent() Present} only if at least one
-     * {@linkplain ClientWriteModel individual write operation} succeed.
+     * {@linkplain ClientNamespacedWriteModel individual write operation} succeed.
      */
     public Optional<ClientBulkWriteResult> getPartialResult() {
         return ofNullable(partialResult);

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

@@ -39,7 +39,7 @@ static ClientBulkWriteOptions clientBulkWriteOptions() {
     }
 
     /**
-     * Enables or disables ordered execution of {@linkplain ClientWriteModel individual write operations}.
+     * Enables or disables ordered execution of {@linkplain ClientNamespacedWriteModel individual write operations}.
      * In an ordered execution a failure of an individual operation prevents the rest of them
      * from being executed.
      * In an unordered execution failures of individual operations do not prevent the rest of them
@@ -60,7 +60,7 @@ static ClientBulkWriteOptions clientBulkWriteOptions() {
     ClientBulkWriteOptions bypassDocumentValidation(@Nullable Boolean bypassDocumentValidation);
 
     /**
-     * Sets variables that can be referenced from {@linkplain ClientWriteModel individual write operations}
+     * Sets variables that can be referenced from {@linkplain ClientNamespacedWriteModel individual write operations}
      * with the {@code "$$"} syntax, which in turn requires using {@link Filters#expr(Object)} when specifying filters.
      * Values must be constants or expressions that do not reference fields.
      *

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

@@ -25,7 +25,7 @@
 
 /**
  * The result of a successful or partially successful client-level bulk write operation.
- * Note that if only some of the {@linkplain ClientWriteModel individual write operations} succeed,
+ * Note that if only some of the {@linkplain ClientNamespacedWriteModel individual write operations} succeed,
  * or if there are {@link WriteConcernError}s, then the successful partial result
  * is still accessible via {@link ClientBulkWriteException#getPartialResult()}.
  *
@@ -100,7 +100,7 @@ public interface ClientBulkWriteResult {
     interface Verbose {
         /**
          * The indexed {@link ClientInsertOneResult}s.
-         * The {@linkplain Map#keySet() keys} are the indexes of the corresponding {@link ClientWriteModel}s
+         * The {@linkplain Map#keySet() keys} are the indexes of the corresponding {@link ClientNamespacedWriteModel}s
          * in the client-level bulk write operation.
          * <p>
          * There are no guarantees on mutability or iteration order of the {@link Map} returned.</p>
@@ -112,7 +112,7 @@ interface Verbose {
 
         /**
          * The indexed {@link ClientUpdateResult}s.
-         * The {@linkplain Map#keySet() keys} are the indexes of the corresponding {@link ClientWriteModel}s
+         * The {@linkplain Map#keySet() keys} are the indexes of the corresponding {@link ClientNamespacedWriteModel}s
          * in the client-level bulk write operation.
          * <p>
          * There are no guarantees on mutability or iteration order of the {@link Map} returned.</p>
@@ -124,7 +124,7 @@ interface Verbose {
 
         /**
          * The indexed {@link ClientDeleteResult}s.
-         * The {@linkplain Map#keySet() keys} are the indexes of the corresponding {@link ClientWriteModel}s
+         * The {@linkplain Map#keySet() keys} are the indexes of the corresponding {@link ClientNamespacedWriteModel}s
          * in the client-level bulk write operation.
          * <p>
          * There are no guarantees on mutability or iteration order of the {@link Map} returned.</p>

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

@@ -19,7 +19,7 @@
 import com.mongodb.bulk.WriteConcernError;
 
 /**
- * The result of a successful {@linkplain ClientWriteModel individual delete operation}.
+ * The result of a successful {@linkplain ClientNamespacedWriteModel individual delete operation}.
  * Note that {@link WriteConcernError}s are not considered as making individuals operations unsuccessful.
  *
  * @since 5.3

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

@@ -23,7 +23,7 @@
 import java.util.Optional;
 
 /**
- * The result of a successful {@linkplain ClientWriteModel individual insert one operation}.
+ * The result of a successful {@linkplain ClientNamespacedWriteModel individual insert one operation}.
  * Note that {@link WriteConcernError}s are not considered as making individuals operations unsuccessful.
  *
  * @since 5.3

driver-core/src/main/com/mongodb/client/model/bulk/ClientDeleteManyModel.java → driver-core/src/main/com/mongodb/client/model/bulk/ClientNamespacedDeleteManyModel.java

@@ -24,5 +24,5 @@
  * @since 5.3
  */
 @Sealed
-public interface ClientDeleteManyModel extends ClientWriteModel {
+public interface ClientNamespacedDeleteManyModel extends ClientNamespacedWriteModel {
 }

driver-core/src/main/com/mongodb/client/model/bulk/ClientDeleteOneModel.java → driver-core/src/main/com/mongodb/client/model/bulk/ClientNamespacedDeleteOneModel.java

@@ -24,5 +24,5 @@
  * @since 5.3
  */
 @Sealed
-public interface ClientDeleteOneModel extends ClientWriteModel {
+public interface ClientNamespacedDeleteOneModel extends ClientNamespacedWriteModel {
 }

driver-core/src/main/com/mongodb/client/model/bulk/ClientInsertOneModel.java → driver-core/src/main/com/mongodb/client/model/bulk/ClientNamespacedInsertOneModel.java

@@ -24,5 +24,5 @@
  * @since 5.3
  */
 @Sealed
-public interface ClientInsertOneModel extends ClientWriteModel {
+public interface ClientNamespacedInsertOneModel extends ClientNamespacedWriteModel {
 }

driver-core/src/main/com/mongodb/client/model/bulk/ClientReplaceOneModel.java → driver-core/src/main/com/mongodb/client/model/bulk/ClientNamespacedReplaceOneModel.java

@@ -24,5 +24,5 @@
  * @since 5.3
  */
 @Sealed
-public interface ClientReplaceOneModel extends ClientWriteModel {
+public interface ClientNamespacedReplaceOneModel extends ClientNamespacedWriteModel {
 }

driver-core/src/main/com/mongodb/client/model/bulk/ClientUpdateManyModel.java → driver-core/src/main/com/mongodb/client/model/bulk/ClientNamespacedUpdateManyModel.java

@@ -24,5 +24,5 @@
  * @since 5.3
  */
 @Sealed
-public interface ClientUpdateManyModel extends ClientWriteModel {
+public interface ClientNamespacedUpdateManyModel extends ClientNamespacedWriteModel {
 }

driver-core/src/main/com/mongodb/client/model/bulk/ClientUpdateOneModel.java → driver-core/src/main/com/mongodb/client/model/bulk/ClientNamespacedUpdateOneModel.java

@@ -24,5 +24,5 @@
  * @since 5.3
  */
 @Sealed
-public interface ClientUpdateOneModel extends ClientWriteModel {
+public interface ClientNamespacedUpdateOneModel extends ClientNamespacedWriteModel {
 }

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

@@ -34,7 +34,7 @@
 import static com.mongodb.assertions.Assertions.notNull;
 
 /**
- * A combination of an {@linkplain ClientWriteModel individual write operation} and a {@linkplain MongoNamespace namespace}
+ * A combination of an individual write operation and a {@linkplain MongoNamespace namespace}
  * the operation is targeted at.
  *
  * @since 5.3
@@ -46,11 +46,11 @@ public interface ClientNamespacedWriteModel {
      *
      * @param namespace The namespace.
      * @param document The document.
-     * @return The requested {@link ClientInsertOneModel} model with the {@code namespace}.
+     * @return The requested {@link ClientNamespacedInsertOneModel}.
      * @param <TDocument> The document type, for example {@link Document}.
      * @see Filters
      */
-    static <TDocument> ClientNamespacedWriteModel insertOne(final MongoNamespace namespace, final TDocument document) {
+    static <TDocument> ClientNamespacedInsertOneModel insertOne(final MongoNamespace namespace, final TDocument document) {
         notNull("namespace", namespace);
         notNull("document", document);
         return new ConcreteClientNamespacedWriteModel(namespace, new ConcreteClientInsertOneModel(document));
@@ -64,11 +64,11 @@ static <TDocument> ClientNamespacedWriteModel insertOne(final MongoNamespace nam
      * @param namespace The namespace.
      * @param filter The filter.
      * @param update The update.
-     * @return The requested {@link ClientUpdateOneModel} model with the {@code namespace}.
+     * @return The requested {@link ClientNamespacedUpdateOneModel}.
      * @see Filters
      * @see Updates
      */
-    static ClientNamespacedWriteModel updateOne(final MongoNamespace namespace, final Bson filter, final Bson update) {
+    static ClientNamespacedUpdateOneModel updateOne(final MongoNamespace namespace, final Bson filter, final Bson update) {
         notNull("namespace", namespace);
         notNull("filter", filter);
         notNull("update", update);
@@ -82,11 +82,11 @@ static ClientNamespacedWriteModel updateOne(final MongoNamespace namespace, fina
      * @param filter The filter.
      * @param update The update.
      * @param options The options.
-     * @return The requested {@link ClientUpdateOneModel} model with the {@code namespace}.
+     * @return The requested {@link ClientNamespacedUpdateOneModel}.
      * @see Filters
      * @see Updates
      */
-    static ClientNamespacedWriteModel updateOne(
+    static ClientNamespacedUpdateOneModel updateOne(
             final MongoNamespace namespace, final Bson filter, final Bson update, final ClientUpdateOptions options) {
         notNull("namespace", namespace);
         notNull("filter", filter);
@@ -103,11 +103,12 @@ static ClientNamespacedWriteModel updateOne(
      * @param namespace The namespace.
      * @param filter The filter.
      * @param updatePipeline The update pipeline.
-     * @return The requested {@link ClientUpdateOneModel} model with the {@code namespace}.
+     * @return The requested {@link ClientNamespacedUpdateOneModel}.
      * @see Filters
      * @see Aggregates
      */
-    static ClientNamespacedWriteModel updateOne(final MongoNamespace namespace, final Bson filter, final Iterable<? extends Bson> updatePipeline) {
+    static ClientNamespacedUpdateOneModel updateOne(
+            final MongoNamespace namespace, final Bson filter, final Iterable<? extends Bson> updatePipeline) {
         notNull("namespace", namespace);
         notNull("filter", filter);
         notNull("updatePipeline", updatePipeline);
@@ -121,11 +122,11 @@ static ClientNamespacedWriteModel updateOne(final MongoNamespace namespace, fina
      * @param filter The filter.
      * @param updatePipeline The update pipeline.
      * @param options The options.
-     * @return The requested {@link ClientUpdateOneModel} model with the {@code namespace}.
+     * @return The requested {@link ClientNamespacedUpdateOneModel}.
      * @see Filters
      * @see Aggregates
      */
-    static ClientNamespacedWriteModel updateOne(
+    static ClientNamespacedUpdateOneModel updateOne(
             final MongoNamespace namespace, final Bson filter, final Iterable<? extends Bson> updatePipeline, final ClientUpdateOptions options) {
         notNull("namespace", namespace);
         notNull("filter", filter);
@@ -142,11 +143,11 @@ static ClientNamespacedWriteModel updateOne(
      * @param namespace The namespace.
      * @param filter The filter.
      * @param update The update.
-     * @return The requested {@link ClientUpdateManyModel} model with the {@code namespace}.
+     * @return The requested {@link ClientNamespacedUpdateManyModel}.
      * @see Filters
      * @see Updates
      */
-    static ClientNamespacedWriteModel updateMany(final MongoNamespace namespace, final Bson filter, final Bson update) {
+    static ClientNamespacedUpdateManyModel updateMany(final MongoNamespace namespace, final Bson filter, final Bson update) {
         notNull("namespace", namespace);
         notNull("filter", filter);
         notNull("update", update);
@@ -160,11 +161,11 @@ static ClientNamespacedWriteModel updateMany(final MongoNamespace namespace, fin
      * @param filter The filter.
      * @param update The update.
      * @param options The options.
-     * @return The requested {@link ClientUpdateManyModel} model with the {@code namespace}.
+     * @return The requested {@link ClientNamespacedUpdateManyModel}.
      * @see Filters
      * @see Updates
      */
-    static ClientNamespacedWriteModel updateMany(
+    static ClientNamespacedUpdateManyModel updateMany(
             final MongoNamespace namespace, final Bson filter, final Bson update, final ClientUpdateOptions options) {
         notNull("namespace", namespace);
         notNull("filter", filter);
@@ -181,11 +182,12 @@ static ClientNamespacedWriteModel updateMany(
      * @param namespace The namespace.
      * @param filter The filter.
      * @param updatePipeline The update pipeline.
-     * @return The requested {@link ClientUpdateManyModel} model with the {@code namespace}.
+     * @return The requested {@link ClientNamespacedUpdateManyModel}.
      * @see Filters
      * @see Aggregates
      */
-    static ClientNamespacedWriteModel updateMany(final MongoNamespace namespace, final Bson filter, final Iterable<? extends Bson> updatePipeline) {
+    static ClientNamespacedUpdateManyModel updateMany(
+            final MongoNamespace namespace, final Bson filter, final Iterable<? extends Bson> updatePipeline) {
         notNull("namespace", namespace);
         notNull("filter", filter);
         notNull("updatePipeline", updatePipeline);
@@ -199,11 +201,11 @@ static ClientNamespacedWriteModel updateMany(final MongoNamespace namespace, fin
      * @param filter The filter.
      * @param updatePipeline The update pipeline.
      * @param options The options.
-     * @return The requested {@link ClientUpdateManyModel} model with the {@code namespace}.
+     * @return The requested {@link ClientNamespacedUpdateManyModel}.
      * @see Filters
      * @see Aggregates
      */
-    static ClientNamespacedWriteModel updateMany(
+    static ClientNamespacedUpdateManyModel updateMany(
             final MongoNamespace namespace, final Bson filter, final Iterable<? extends Bson> updatePipeline, final ClientUpdateOptions options) {
         notNull("namespace", namespace);
         notNull("filter", filter);
@@ -221,11 +223,11 @@ static ClientNamespacedWriteModel updateMany(
      * @param filter The filter.
      * @param replacement The replacement.
      * The keys of this document must not start with {@code $}, unless they express a {@linkplain com.mongodb.DBRef database reference}.
-     * @return The requested {@link ClientReplaceOneModel} model with the {@code namespace}.
+     * @return The requested {@link ClientNamespacedReplaceOneModel}.
      * @param <TDocument> The document type, for example {@link Document}.
      * @see Filters
      */
-    static <TDocument> ClientNamespacedWriteModel replaceOne(final MongoNamespace namespace, final Bson filter, final TDocument replacement) {
+    static <TDocument> ClientNamespacedReplaceOneModel replaceOne(final MongoNamespace namespace, final Bson filter, final TDocument replacement) {
         notNull("namespace", namespace);
         notNull("filter", filter);
         notNull("replacement", replacement);
@@ -240,11 +242,11 @@ static <TDocument> ClientNamespacedWriteModel replaceOne(final MongoNamespace na
      * @param replacement The replacement.
      * The keys of this document must not start with {@code $}, unless they express a {@linkplain com.mongodb.DBRef database reference}.
      * @param options The options.
-     * @return The requested {@link ClientReplaceOneModel} model with the {@code namespace}.
+     * @return The requested {@link ClientNamespacedReplaceOneModel}.
      * @param <TDocument> The document type, for example {@link Document}.
      * @see Filters
      */
-    static <TDocument> ClientNamespacedWriteModel replaceOne(
+    static <TDocument> ClientNamespacedReplaceOneModel replaceOne(
             final MongoNamespace namespace, final Bson filter, final TDocument replacement, final ClientReplaceOptions options) {
         notNull("namespace", namespace);
         notNull("filter", filter);
@@ -260,10 +262,10 @@ static <TDocument> ClientNamespacedWriteModel replaceOne(
      *
      * @param namespace The namespace.
      * @param filter The filter.
-     * @return The requested {@link ClientDeleteOneModel} model with the {@code namespace}.
+     * @return The requested {@link ClientNamespacedDeleteOneModel}.
      * @see Filters
      */
-    static ClientNamespacedWriteModel deleteOne(final MongoNamespace namespace, final Bson filter) {
+    static ClientNamespacedDeleteOneModel deleteOne(final MongoNamespace namespace, final Bson filter) {
         notNull("namespace", namespace);
         notNull("filter", filter);
         return new ConcreteClientNamespacedWriteModel(namespace, new ConcreteClientDeleteOneModel(filter, null));
@@ -275,10 +277,10 @@ static ClientNamespacedWriteModel deleteOne(final MongoNamespace namespace, fina
      * @param namespace The namespace.
      * @param filter The filter.
      * @param options The options.
-     * @return The requested {@link ClientDeleteOneModel} model with the {@code namespace}.
+     * @return The requested {@link ClientNamespacedDeleteOneModel}.
      * @see Filters
      */
-    static ClientNamespacedWriteModel deleteOne(final MongoNamespace namespace, final Bson filter, final ClientDeleteOptions options) {
+    static ClientNamespacedDeleteOneModel deleteOne(final MongoNamespace namespace, final Bson filter, final ClientDeleteOptions options) {
         notNull("namespace", namespace);
         notNull("filter", filter);
         notNull("options", options);
@@ -292,10 +294,10 @@ static ClientNamespacedWriteModel deleteOne(final MongoNamespace namespace, fina
      *
      * @param namespace The namespace.
      * @param filter The filter.
-     * @return The requested {@link ClientDeleteManyModel} model with the {@code namespace}.
+     * @return The requested {@link ClientNamespacedDeleteManyModel}.
      * @see Filters
      */
-    static ClientNamespacedWriteModel deleteMany(final MongoNamespace namespace, final Bson filter) {
+    static ClientNamespacedDeleteManyModel deleteMany(final MongoNamespace namespace, final Bson filter) {
         notNull("namespace", namespace);
         notNull("filter", filter);
         return new ConcreteClientNamespacedWriteModel(namespace, new ConcreteClientDeleteManyModel(filter, null));
@@ -307,10 +309,10 @@ static ClientNamespacedWriteModel deleteMany(final MongoNamespace namespace, fin
      * @param namespace The namespace.
      * @param filter The filter.
      * @param options The options.
-     * @return The requested {@link ClientDeleteManyModel} model with the {@code namespace}.
+     * @return The requested {@link ClientNamespacedDeleteManyModel}.
      * @see Filters
      */
-    static ClientNamespacedWriteModel deleteMany(final MongoNamespace namespace, final Bson filter, final ClientDeleteOptions options) {
+    static ClientNamespacedDeleteManyModel deleteMany(final MongoNamespace namespace, final Bson filter, final ClientDeleteOptions options) {
         notNull("namespace", namespace);
         notNull("filter", filter);
         notNull("options", options);

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

@@ -22,7 +22,7 @@
 import java.util.Optional;
 
 /**
- * The result of a successful {@linkplain ClientWriteModel individual update or replace operation}.
+ * The result of a successful {@linkplain ClientNamespacedWriteModel individual update or replace operation}.
  * Note that {@link WriteConcernError}s are not considered as making individuals operations unsuccessful.
  *
  * @since 5.3

driver-core/src/main/com/mongodb/client/model/bulk/ClientWriteModel.java → driver-core/src/main/com/mongodb/internal/client/model/bulk/ClientWriteModel.java

@@ -13,15 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.mongodb.client.model.bulk;
-
-import com.mongodb.annotations.Sealed;
+package com.mongodb.internal.client.model.bulk;
 
 /**
  * An individual write operation to be executed as part of a client-level bulk write operation.
- *
- * @since 5.3
+ * <p>
+ * This class is not part of the public API and may be removed or changed at any time.</p>
  */
-@Sealed
 public interface ClientWriteModel {
 }