JAVA-2564: Deprecate OperationExecutor in driver-core and created a new non-public interface in the driver module

jyemin · jyemin · commit d2c1ba0fd03a · 2017-09-15T20:24:53.000-04:00
diff --git a/driver-core/src/main/com/mongodb/operation/OperationExecutor.java b/driver-core/src/main/com/mongodb/operation/OperationExecutor.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2008-2014 MongoDB, Inc.
+ * Copyright 2008-2017 MongoDB, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,7 +22,9 @@
  * An interface describing the execution of a read or a write operation.
  *
  * @since 3.0
+ * @deprecated there is no replacement for this interface
  */
+@Deprecated
 public interface OperationExecutor {
     /**
      * Execute the read operation with the given read preference.
diff --git a/driver/src/main/com/mongodb/AggregateIterableImpl.java b/driver/src/main/com/mongodb/AggregateIterableImpl.java
@@ -24,7 +24,6 @@
 import com.mongodb.client.model.FindOptions;
 import com.mongodb.operation.AggregateOperation;
 import com.mongodb.operation.AggregateToCollectionOperation;
-import com.mongodb.operation.OperationExecutor;
 import org.bson.BsonDocument;
 import org.bson.BsonValue;
 import org.bson.codecs.configuration.CodecRegistry;
diff --git a/driver/src/main/com/mongodb/ChangeStreamIterableImpl.java b/driver/src/main/com/mongodb/ChangeStreamIterableImpl.java
@@ -23,7 +23,6 @@
 import com.mongodb.client.model.changestream.ChangeStreamDocument;
 import com.mongodb.client.model.changestream.FullDocument;
 import com.mongodb.operation.ChangeStreamOperation;
-import com.mongodb.operation.OperationExecutor;
 import org.bson.BsonDocument;
 import org.bson.codecs.Codec;
 import org.bson.codecs.configuration.CodecRegistry;
diff --git a/driver/src/main/com/mongodb/DB.java b/driver/src/main/com/mongodb/DB.java
@@ -30,7 +30,6 @@
 import com.mongodb.operation.DropDatabaseOperation;
 import com.mongodb.operation.DropUserOperation;
 import com.mongodb.operation.ListCollectionsOperation;
-import com.mongodb.operation.OperationExecutor;
 import com.mongodb.operation.UpdateUserOperation;
 import com.mongodb.operation.UserExistsOperation;
 import org.bson.BsonDocument;
diff --git a/driver/src/main/com/mongodb/DBCollection.java b/driver/src/main/com/mongodb/DBCollection.java
@@ -48,7 +48,6 @@
 import com.mongodb.operation.MapReduceToCollectionOperation;
 import com.mongodb.operation.MapReduceWithInlineResultsOperation;
 import com.mongodb.operation.MixedBulkWriteOperation;
-import com.mongodb.operation.OperationExecutor;
 import com.mongodb.operation.ParallelCollectionScanOperation;
 import com.mongodb.operation.RenameCollectionOperation;
 import com.mongodb.operation.UpdateOperation;
diff --git a/driver/src/main/com/mongodb/DBCursor.java b/driver/src/main/com/mongodb/DBCursor.java
@@ -22,7 +22,6 @@
 import com.mongodb.client.model.DBCollectionCountOptions;
 import com.mongodb.client.model.DBCollectionFindOptions;
 import com.mongodb.operation.FindOperation;
-import com.mongodb.operation.OperationExecutor;
 import org.bson.codecs.Decoder;
 
 import java.util.ArrayList;
diff --git a/driver/src/main/com/mongodb/DistinctIterableImpl.java b/driver/src/main/com/mongodb/DistinctIterableImpl.java
@@ -21,7 +21,6 @@
 import com.mongodb.client.MongoIterable;
 import com.mongodb.client.model.Collation;
 import com.mongodb.operation.DistinctOperation;
-import com.mongodb.operation.OperationExecutor;
 import org.bson.codecs.configuration.CodecRegistry;
 import org.bson.conversions.Bson;
 
diff --git a/driver/src/main/com/mongodb/FindIterableImpl.java b/driver/src/main/com/mongodb/FindIterableImpl.java
@@ -23,7 +23,6 @@
 import com.mongodb.client.model.FindOptions;
 import com.mongodb.operation.BatchCursor;
 import com.mongodb.operation.FindOperation;
-import com.mongodb.operation.OperationExecutor;
 import org.bson.BsonDocument;
 import org.bson.codecs.configuration.CodecRegistry;
 import org.bson.conversions.Bson;
diff --git a/driver/src/main/com/mongodb/ListCollectionsIterableImpl.java b/driver/src/main/com/mongodb/ListCollectionsIterableImpl.java
@@ -20,7 +20,6 @@
 import com.mongodb.client.MongoCursor;
 import com.mongodb.client.MongoIterable;
 import com.mongodb.operation.ListCollectionsOperation;
-import com.mongodb.operation.OperationExecutor;
 import org.bson.BsonDocument;
 import org.bson.codecs.configuration.CodecRegistry;
 import org.bson.conversions.Bson;
diff --git a/driver/src/main/com/mongodb/ListDatabasesIterableImpl.java b/driver/src/main/com/mongodb/ListDatabasesIterableImpl.java
@@ -19,7 +19,6 @@
 import com.mongodb.client.MongoCursor;
 import com.mongodb.client.MongoIterable;
 import com.mongodb.operation.ListDatabasesOperation;
-import com.mongodb.operation.OperationExecutor;
 import org.bson.codecs.configuration.CodecRegistry;
 
 import java.util.Collection;
diff --git a/driver/src/main/com/mongodb/ListIndexesIterableImpl.java b/driver/src/main/com/mongodb/ListIndexesIterableImpl.java
@@ -20,7 +20,6 @@
 import com.mongodb.client.MongoCursor;
 import com.mongodb.client.MongoIterable;
 import com.mongodb.operation.ListIndexesOperation;
-import com.mongodb.operation.OperationExecutor;
 import org.bson.codecs.configuration.CodecRegistry;
 
 import java.util.Collection;
diff --git a/driver/src/main/com/mongodb/MapReduceIterableImpl.java b/driver/src/main/com/mongodb/MapReduceIterableImpl.java
@@ -24,7 +24,6 @@
 import com.mongodb.client.model.MapReduceAction;
 import com.mongodb.operation.MapReduceToCollectionOperation;
 import com.mongodb.operation.MapReduceWithInlineResultsOperation;
-import com.mongodb.operation.OperationExecutor;
 import org.bson.BsonDocument;
 import org.bson.BsonJavaScript;
 import org.bson.codecs.configuration.CodecRegistry;
diff --git a/driver/src/main/com/mongodb/Mongo.java b/driver/src/main/com/mongodb/Mongo.java
@@ -39,7 +39,6 @@
 import com.mongodb.operation.CurrentOpOperation;
 import com.mongodb.operation.FsyncUnlockOperation;
 import com.mongodb.operation.ListDatabasesOperation;
-import com.mongodb.operation.OperationExecutor;
 import com.mongodb.operation.ReadOperation;
 import com.mongodb.operation.WriteOperation;
 import com.mongodb.selector.LatencyMinimizingServerSelector;
diff --git a/driver/src/main/com/mongodb/MongoCollectionImpl.java b/driver/src/main/com/mongodb/MongoCollectionImpl.java
@@ -60,7 +60,6 @@
 import com.mongodb.operation.FindAndReplaceOperation;
 import com.mongodb.operation.FindAndUpdateOperation;
 import com.mongodb.operation.MixedBulkWriteOperation;
-import com.mongodb.operation.OperationExecutor;
 import com.mongodb.operation.RenameCollectionOperation;
 import org.bson.BsonDocument;
 import org.bson.BsonDocumentWrapper;
diff --git a/driver/src/main/com/mongodb/MongoDatabaseImpl.java b/driver/src/main/com/mongodb/MongoDatabaseImpl.java
@@ -28,7 +28,6 @@
 import com.mongodb.operation.CreateCollectionOperation;
 import com.mongodb.operation.CreateViewOperation;
 import com.mongodb.operation.DropDatabaseOperation;
-import com.mongodb.operation.OperationExecutor;
 import org.bson.BsonDocument;
 import org.bson.Document;
 import org.bson.codecs.configuration.CodecRegistry;
diff --git a/driver/src/main/com/mongodb/OperationExecutor.java b/driver/src/main/com/mongodb/OperationExecutor.java
@@ -0,0 +1,44 @@
+/*
+ * Copyright 2008-2017 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;
+
+import com.mongodb.operation.ReadOperation;
+import com.mongodb.operation.WriteOperation;
+
+/**
+ * An interface describing the execution of a read or a write operation.
+ */
+interface OperationExecutor {
+    /**
+     * Execute the read operation with the given read preference.
+     *
+     * @param <T> the operations result type.
+     * @param operation the read operation.
+     * @param readPreference the read preference.
+     * @return the result of executing the operation.
+     */
+    <T> T execute(ReadOperation<T> operation, ReadPreference readPreference);
+
+    /**
+     * Execute the write operation.
+     *
+     * @param operation the write operation.
+     * @param <T> the operations result type.
+     * @return the result of executing the operation.
+     */
+    <T> T execute(WriteOperation<T> operation);
+}
diff --git a/driver/src/main/com/mongodb/OperationIterable.java b/driver/src/main/com/mongodb/OperationIterable.java
@@ -19,7 +19,6 @@
 import com.mongodb.client.MongoCursor;
 import com.mongodb.client.MongoIterable;
 import com.mongodb.operation.BatchCursor;
-import com.mongodb.operation.OperationExecutor;
 import com.mongodb.operation.ReadOperation;
 
 import java.util.Collection;
diff --git a/driver/src/test/functional/com/mongodb/DBFunctionalSpecification.groovy b/driver/src/test/functional/com/mongodb/DBFunctionalSpecification.groovy
@@ -16,7 +16,6 @@
 
 package com.mongodb
 
-import com.mongodb.operation.OperationExecutor
 import org.bson.BsonDocument
 import org.bson.BsonDouble
 import org.bson.BsonInt32
diff --git a/driver/src/test/unit/com/mongodb/MongoCollectionSpecification.groovy b/driver/src/test/unit/com/mongodb/MongoCollectionSpecification.groovy
@@ -54,7 +54,6 @@ import com.mongodb.operation.FindAndReplaceOperation
 import com.mongodb.operation.FindAndUpdateOperation
 import com.mongodb.operation.ListIndexesOperation
 import com.mongodb.operation.MixedBulkWriteOperation
-import com.mongodb.operation.OperationExecutor
 import com.mongodb.operation.RenameCollectionOperation
 import org.bson.BsonDocument
 import org.bson.BsonInt32
diff --git a/driver/src/test/unit/com/mongodb/MongoDatabaseSpecification.groovy b/driver/src/test/unit/com/mongodb/MongoDatabaseSpecification.groovy
@@ -27,7 +27,6 @@ import com.mongodb.operation.CommandReadOperation
 import com.mongodb.operation.CreateCollectionOperation
 import com.mongodb.operation.CreateViewOperation
 import com.mongodb.operation.DropDatabaseOperation
-import com.mongodb.operation.OperationExecutor
 import org.bson.BsonBoolean
 import org.bson.BsonDocument
 import org.bson.BsonInt32
diff --git a/driver/src/test/unit/com/mongodb/TestOperationExecutor.java b/driver/src/test/unit/com/mongodb/TestOperationExecutor.java
@@ -16,7 +16,6 @@
 
 package com.mongodb;
 
-import com.mongodb.operation.OperationExecutor;
 import com.mongodb.operation.ReadOperation;
 import com.mongodb.operation.WriteOperation;
 
diff --git a/driver/src/test/unit/com/mongodb/client/gridfs/GridFSBucketSpecification.groovy b/driver/src/test/unit/com/mongodb/client/gridfs/GridFSBucketSpecification.groovy
@@ -33,7 +33,7 @@ import com.mongodb.client.result.DeleteResult
 import com.mongodb.client.result.UpdateResult
 import com.mongodb.operation.BatchCursor
 import com.mongodb.operation.FindOperation
-import com.mongodb.operation.OperationExecutor
+import com.mongodb.OperationExecutor
 import org.bson.BsonDocument
 import org.bson.BsonObjectId
 import org.bson.BsonString
diff --git a/driver/src/test/unit/com/mongodb/client/gridfs/GridFSBucketsSpecification.groovy b/driver/src/test/unit/com/mongodb/client/gridfs/GridFSBucketsSpecification.groovy
@@ -20,7 +20,7 @@ import com.mongodb.MongoDatabaseImpl
 import com.mongodb.ReadConcern
 import com.mongodb.ReadPreference
 import com.mongodb.WriteConcern
-import com.mongodb.operation.OperationExecutor
+import com.mongodb.OperationExecutor
 import org.bson.codecs.configuration.CodecRegistry
 import spock.lang.Specification
 
