Rearrange ClientWriteModel inheritance: neither "one" nor "many" should extend each other

Such extending turned out to be confusing

JAVA-5527

Author: stIncMale

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

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2008-present MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.mongodb.internal.client.model.bulk;
+
+import com.mongodb.client.model.bulk.ClientDeleteOptions;
+import com.mongodb.lang.Nullable;
+import org.bson.conversions.Bson;
+
+/**
+ * This class is not part of the public API and may be removed or changed at any time.
+ */
+abstract class AbstractClientDeleteModel implements ClientWriteModel {
+    private final Bson filter;
+    private final ConcreteClientDeleteOptions options;
+
+    AbstractClientDeleteModel(final Bson filter, @Nullable final ClientDeleteOptions options) {
+        this.filter = filter;
+        this.options = options == null ? ConcreteClientDeleteOptions.MUTABLE_EMPTY : (ConcreteClientDeleteOptions) options;
+    }
+
+    public final Bson getFilter() {
+        return filter;
+    }
+
+    public final ConcreteClientDeleteOptions getOptions() {
+        return options;
+    }
+
+    abstract String getToStringDescription();
+
+    @Override
+    public final String toString() {
+        return getToStringDescription()
+                + "{filter=" + filter
+                + ", options=" + options
+                + '}';
+    }
+}

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

@@ -0,0 +1,75 @@
+/*
+ * Copyright 2008-present MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.mongodb.internal.client.model.bulk;
+
+import com.mongodb.client.model.bulk.ClientUpdateOptions;
+import com.mongodb.lang.Nullable;
+import org.bson.conversions.Bson;
+
+import java.util.Optional;
+
+import static com.mongodb.assertions.Assertions.assertTrue;
+import static java.util.Optional.ofNullable;
+
+abstract class AbstractClientUpdateModel {
+    private final Bson filter;
+    @Nullable
+    private final Bson update;
+    @Nullable
+    private final Iterable<? extends Bson> updatePipeline;
+    private final ConcreteClientUpdateOptions options;
+
+    AbstractClientUpdateModel(
+            final Bson filter,
+            @Nullable
+            final Bson update,
+            @Nullable
+            final Iterable<? extends Bson> updatePipeline,
+            @Nullable final ClientUpdateOptions options) {
+        this.filter = filter;
+        assertTrue(update == null ^ updatePipeline == null);
+        this.update = update;
+        this.updatePipeline = updatePipeline;
+        this.options = options == null ? ConcreteClientUpdateOptions.MUTABLE_EMPTY : (ConcreteClientUpdateOptions) options;
+    }
+
+    public final Bson getFilter() {
+        return filter;
+    }
+
+    public final Optional<Bson> getUpdate() {
+        return ofNullable(update);
+    }
+
+    public final Optional<Iterable<? extends Bson>> getUpdatePipeline() {
+        return ofNullable(updatePipeline);
+    }
+
+    public final ConcreteClientUpdateOptions getOptions() {
+        return options;
+    }
+
+    abstract String getToStringDescription();
+
+    @Override
+    public final String toString() {
+        return getToStringDescription()
+                + "{filter=" + filter
+                + ", update=" + (update != null ? update : updatePipeline)
+                + ", options=" + options
+                + '}';
+    }
+}

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

@@ -160,7 +160,7 @@ public int hashCode() {
         @Override
         public String toString() {
             return "AcknowledgedVerboseClientBulkWriteResult.Verbose{"
-                    + ", insertResults=" + insertResults
+                    + "insertResults=" + insertResults
                     + ", updateResults=" + updateResults
                     + ", deleteResults=" + deleteResults
                     + '}';

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

@@ -22,28 +22,13 @@
 /**
  * This class is not part of the public API and may be removed or changed at any time.
  */
-public class ConcreteClientDeleteManyModel implements ClientWriteModel {
-    private final Bson filter;
-    private final ConcreteClientDeleteOptions options;
-
+public final class ConcreteClientDeleteManyModel extends AbstractClientDeleteModel implements ClientWriteModel {
     public ConcreteClientDeleteManyModel(final Bson filter, @Nullable final ClientDeleteOptions options) {
-        this.filter = filter;
-        this.options = options == null ? ConcreteClientDeleteOptions.MUTABLE_EMPTY : (ConcreteClientDeleteOptions) options;
-    }
-
-    public Bson getFilter() {
-        return filter;
-    }
-
-    public ConcreteClientDeleteOptions getOptions() {
-        return options;
+        super(filter, options);
     }
 
     @Override
-    public String toString() {
-        return "ClientDeleteManyModel{"
-                + ", filter=" + filter
-                + ", options=" + options
-                + '}';
+    String getToStringDescription() {
+        return "ClientDeleteManyModel";
     }
 }

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

@@ -22,16 +22,13 @@
 /**
  * This class is not part of the public API and may be removed or changed at any time.
  */
-public final class ConcreteClientDeleteOneModel extends ConcreteClientDeleteManyModel {
+public final class ConcreteClientDeleteOneModel extends AbstractClientDeleteModel implements ClientWriteModel {
     public ConcreteClientDeleteOneModel(final Bson filter, @Nullable final ClientDeleteOptions options) {
         super(filter, options);
     }
 
     @Override
-    public String toString() {
-        return "ClientDeleteOneModel{"
-                + ", filter=" + getFilter()
-                + ", options=" + getOptions()
-                + '}';
+    String getToStringDescription() {
+        return "ClientDeleteOneModel";
     }
 }

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

@@ -32,7 +32,7 @@ public Object getDocument() {
     @Override
     public String toString() {
         return "ClientInsertOneModel{"
-                + ", document=" + document
+                + "document=" + document
                 + '}';
     }
 }

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

@@ -48,7 +48,7 @@ public ConcreteClientReplaceOptions getOptions() {
     @Override
     public String toString() {
         return "ClientReplaceOneModel{"
-                + ", filter=" + filter
+                + "filter=" + filter
                 + ", replacement=" + replacement
                 + ", options=" + options
                 + '}';

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

@@ -19,58 +19,22 @@
 import com.mongodb.lang.Nullable;
 import org.bson.conversions.Bson;
 
-import java.util.Optional;
-
-import static com.mongodb.assertions.Assertions.assertTrue;
-import static java.util.Optional.ofNullable;
-
 /**
  * This class is not part of the public API and may be removed or changed at any time.
  */
-public class ConcreteClientUpdateManyModel implements ClientWriteModel {
-    private final Bson filter;
-    @Nullable
-    private final Bson update;
-    @Nullable
-    private final Iterable<? extends Bson> updatePipeline;
-    private final ConcreteClientUpdateOptions options;
-
+public final class ConcreteClientUpdateManyModel extends AbstractClientUpdateModel implements ClientWriteModel {
     public ConcreteClientUpdateManyModel(
             final Bson filter,
             @Nullable
             final Bson update,
             @Nullable
             final Iterable<? extends Bson> updatePipeline,
             @Nullable final ClientUpdateOptions options) {
-        this.filter = filter;
-        assertTrue(update == null ^ updatePipeline == null);
-        this.update = update;
-        this.updatePipeline = updatePipeline;
-        this.options = options == null ? ConcreteClientUpdateOptions.MUTABLE_EMPTY : (ConcreteClientUpdateOptions) options;
-    }
-
-    public Bson getFilter() {
-        return filter;
-    }
-
-    public Optional<Bson> getUpdate() {
-        return ofNullable(update);
-    }
-
-    public Optional<Iterable<? extends Bson>> getUpdatePipeline() {
-        return ofNullable(updatePipeline);
-    }
-
-    public ConcreteClientUpdateOptions getOptions() {
-        return options;
+        super(filter, update, updatePipeline, options);
     }
 
     @Override
-    public String toString() {
-        return "ClientUpdateManyModel{"
-                + ", filter=" + filter
-                + ", update=" + (update != null ? update : updatePipeline)
-                + ", options=" + options
-                + '}';
+    String getToStringDescription() {
+        return "ClientUpdateManyModel";
     }
 }

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

@@ -15,15 +15,14 @@
  */
 package com.mongodb.internal.client.model.bulk;
 
-import com.mongodb.assertions.Assertions;
 import com.mongodb.client.model.bulk.ClientUpdateOptions;
 import com.mongodb.lang.Nullable;
 import org.bson.conversions.Bson;
 
 /**
  * This class is not part of the public API and may be removed or changed at any time.
  */
-public final class ConcreteClientUpdateOneModel extends ConcreteClientUpdateManyModel {
+public final class ConcreteClientUpdateOneModel extends AbstractClientUpdateModel implements ClientWriteModel {
     public ConcreteClientUpdateOneModel(
             final Bson filter,
             @Nullable
@@ -35,13 +34,7 @@ public ConcreteClientUpdateOneModel(
     }
 
     @Override
-    public String toString() {
-        return "ClientUpdateOneModel{"
-                + ", filter=" + getFilter()
-                + ", update=" + getUpdate().map(Object::toString)
-                .orElse(getUpdatePipeline().map(Object::toString)
-                        .orElseThrow(Assertions::fail))
-                + ", options=" + getOptions()
-                + '}';
+    String getToStringDescription() {
+        return "ClientUpdateOneModel";
     }
 }