s/Builder/Template/

Author: fbiville

driver/clirr-ignored-differences.xml

@@ -412,7 +412,7 @@
     <difference>
         <className>org/neo4j/driver/Driver</className>
         <differenceType>7012</differenceType>
-        <method>org.neo4j.driver.ExecuteQueryBuilder executeQueryBuilder(java.lang.String)</method>
+        <method>org.neo4j.driver.ExecuteQueryTemplate executeQueryTemplate(java.lang.String)</method>
     </difference>
 
     <difference>

driver/src/main/java/org/neo4j/driver/Driver.java

@@ -64,18 +64,18 @@
  */
 public interface Driver extends AutoCloseable {
     /**
-     * Creates a new {@link ExecuteQueryBuilder} instance that executes a query in a managed transaction with automatic retries on
+     * Creates a new {@link ExecuteQueryTemplate} instance that executes a query in a managed transaction with automatic retries on
      * retryable errors.
      *
      * @param query query string
      * @return new query task instance
      * @since 5.5
      */
     @Experimental
-    ExecuteQueryBuilder executeQueryBuilder(String query);
+    ExecuteQueryTemplate executeQueryTemplate(String query);
 
     /**
-     * Returns an instance of {@link BookmarkManager} used by {@link ExecuteQueryBuilder} instances by default.
+     * Returns an instance of {@link BookmarkManager} used by {@link ExecuteQueryTemplate} instances by default.
      *
      * @return bookmark manager, must not be {@code null}
      * @since 5.6

driver/src/main/java/org/neo4j/driver/ExecuteQueryConfig.java

@@ -27,7 +27,7 @@
 import org.neo4j.driver.util.Experimental;
 
 /**
- * Query configuration used by {@link Driver#executeQueryBuilder(String)} and its variants.
+ * Query configuration used by {@link Driver#executeQueryTemplate(String)} and its variants.
  * @since 5.5
  */
 @Experimental

driver/src/main/java/org/neo4j/driver/ExecuteQueryBuilder.java renamed to driver/src/main/java/org/neo4j/driver/ExecuteQueryTemplate.java

@@ -97,24 +97,24 @@
  * @since 5.5
  */
 @Experimental
-public interface ExecuteQueryBuilder {
+public interface ExecuteQueryTemplate {
     /**
      * Sets query parameters.
      *
      * @param parameters parameters map, must not be {@code null}
      * @return a new query task
      */
-    ExecuteQueryBuilder withParameters(Map<String, Object> parameters);
+    ExecuteQueryTemplate withParameters(Map<String, Object> parameters);
 
     /**
      * Sets {@link ExecuteQueryConfig}.
      * <p>
-     * By default, {@link ExecuteQueryBuilder} has {@link ExecuteQueryConfig#defaultConfig()} value.
+     * By default, {@link ExecuteQueryTemplate} has {@link ExecuteQueryConfig#defaultConfig()} value.
      *
      * @param config query config, must not be {@code null}
      * @return a new query task
      */
-    ExecuteQueryBuilder withConfig(ExecuteQueryConfig config);
+    ExecuteQueryTemplate withConfig(ExecuteQueryConfig config);
 
     /**
      * Executes query, collects all results eagerly and returns a result.

driver/src/main/java/org/neo4j/driver/internal/InternalDriver.java

@@ -33,7 +33,7 @@
 import org.neo4j.driver.Metrics;
 import org.neo4j.driver.Query;
 import org.neo4j.driver.ExecuteQueryConfig;
-import org.neo4j.driver.ExecuteQueryBuilder;
+import org.neo4j.driver.ExecuteQueryTemplate;
 import org.neo4j.driver.Session;
 import org.neo4j.driver.SessionConfig;
 import org.neo4j.driver.async.AsyncSession;
@@ -69,8 +69,8 @@ public class InternalDriver implements Driver {
     }
 
     @Override
-    public ExecuteQueryBuilder executeQueryBuilder(String query) {
-        return new InternalExecuteQueryBuilder(this, new Query(query), ExecuteQueryConfig.defaultConfig());
+    public ExecuteQueryTemplate executeQueryTemplate(String query) {
+        return new InternalExecuteQueryTemplate(this, new Query(query), ExecuteQueryConfig.defaultConfig());
     }
 
     @Override

driver/src/main/java/org/neo4j/driver/internal/InternalExecuteQueryBuilder.java renamed to driver/src/main/java/org/neo4j/driver/internal/InternalExecuteQueryTemplate.java

@@ -25,17 +25,17 @@
 import org.neo4j.driver.Driver;
 import org.neo4j.driver.Query;
 import org.neo4j.driver.ExecuteQueryConfig;
-import org.neo4j.driver.ExecuteQueryBuilder;
+import org.neo4j.driver.ExecuteQueryTemplate;
 import org.neo4j.driver.Record;
 import org.neo4j.driver.SessionConfig;
 import org.neo4j.driver.TransactionCallback;
 
-public class InternalExecuteQueryBuilder implements ExecuteQueryBuilder {
+public class InternalExecuteQueryTemplate implements ExecuteQueryTemplate {
     private final Driver driver;
     private final Query query;
     private final ExecuteQueryConfig config;
 
-    public InternalExecuteQueryBuilder(Driver driver, Query query, ExecuteQueryConfig config) {
+    public InternalExecuteQueryTemplate(Driver driver, Query query, ExecuteQueryConfig config) {
         requireNonNull(driver, "driver must not be null");
         requireNonNull(query, "query must not be null");
         requireNonNull(config, "config must not be null");
@@ -45,15 +45,15 @@ public InternalExecuteQueryBuilder(Driver driver, Query query, ExecuteQueryConfi
     }
 
     @Override
-    public ExecuteQueryBuilder withParameters(Map<String, Object> parameters) {
+    public ExecuteQueryTemplate withParameters(Map<String, Object> parameters) {
         requireNonNull(parameters, "parameters must not be null");
-        return new InternalExecuteQueryBuilder(driver, query.withParameters(parameters), config);
+        return new InternalExecuteQueryTemplate(driver, query.withParameters(parameters), config);
     }
 
     @Override
-    public ExecuteQueryBuilder withConfig(ExecuteQueryConfig config) {
+    public ExecuteQueryTemplate withConfig(ExecuteQueryConfig config) {
         requireNonNull(config, "config must not be null");
-        return new InternalExecuteQueryBuilder(driver, query, config);
+        return new InternalExecuteQueryTemplate(driver, query, config);
     }
 
     @Override

driver/src/test/java/org/neo4j/driver/internal/InternalDriverTest.java

@@ -120,7 +120,7 @@ void shouldCreateQueryTask() {
         var query = "string";
 
         // When
-        var queryTask = (InternalExecuteQueryBuilder) driver.executeQueryBuilder(query);
+        var queryTask = (InternalExecuteQueryTemplate) driver.executeQueryTemplate(query);
 
         // Then
         assertNotNull(queryTask);

driver/src/test/java/org/neo4j/driver/internal/InternalExecuteQueryBuilderTest.java renamed to driver/src/test/java/org/neo4j/driver/internal/InternalExecuteQueryTemplateTest.java

@@ -40,7 +40,7 @@
 import org.neo4j.driver.Driver;
 import org.neo4j.driver.Query;
 import org.neo4j.driver.ExecuteQueryConfig;
-import org.neo4j.driver.ExecuteQueryBuilder;
+import org.neo4j.driver.ExecuteQueryTemplate;
 import org.neo4j.driver.Record;
 import org.neo4j.driver.Result;
 import org.neo4j.driver.RoutingControl;
@@ -50,30 +50,30 @@
 import org.neo4j.driver.TransactionContext;
 import org.neo4j.driver.summary.ResultSummary;
 
-class InternalExecuteQueryBuilderTest {
+class InternalExecuteQueryTemplateTest {
     @Test
     void shouldNotAcceptNullDriverOnInstantiation() {
         assertThrows(
                 NullPointerException.class,
-                () -> new InternalExecuteQueryBuilder(null, new Query("string"), ExecuteQueryConfig.defaultConfig()));
+                () -> new InternalExecuteQueryTemplate(null, new Query("string"), ExecuteQueryConfig.defaultConfig()));
     }
 
     @Test
     void shouldNotAcceptNullQueryOnInstantiation() {
         assertThrows(
                 NullPointerException.class,
-                () -> new InternalExecuteQueryBuilder(mock(Driver.class), null, ExecuteQueryConfig.defaultConfig()));
+                () -> new InternalExecuteQueryTemplate(mock(Driver.class), null, ExecuteQueryConfig.defaultConfig()));
     }
 
     @Test
     void shouldNotAcceptNullConfigOnInstantiation() {
         assertThrows(
-                NullPointerException.class, () -> new InternalExecuteQueryBuilder(mock(Driver.class), new Query("string"), null));
+                NullPointerException.class, () -> new InternalExecuteQueryTemplate(mock(Driver.class), new Query("string"), null));
     }
 
     @Test
     void shouldNotAcceptNullParameters() {
-        var queryTask = new InternalExecuteQueryBuilder(mock(Driver.class), new Query("string"), ExecuteQueryConfig.defaultConfig());
+        var queryTask = new InternalExecuteQueryTemplate(mock(Driver.class), new Query("string"), ExecuteQueryConfig.defaultConfig());
         assertThrows(NullPointerException.class, () -> queryTask.withParameters(null));
     }
 
@@ -82,30 +82,30 @@ void shouldUpdateParameters() {
         // GIVEN
         var query = new Query("string");
         var params = Map.<String, Object>of("$param", "value");
-        var queryTask = new InternalExecuteQueryBuilder(mock(Driver.class), query, ExecuteQueryConfig.defaultConfig());
+        var queryTask = new InternalExecuteQueryTemplate(mock(Driver.class), query, ExecuteQueryConfig.defaultConfig());
 
         // WHEN
-        queryTask = (InternalExecuteQueryBuilder) queryTask.withParameters(params);
+        queryTask = (InternalExecuteQueryTemplate) queryTask.withParameters(params);
 
         // THEN
         assertEquals(params, queryTask.parameters());
     }
 
     @Test
     void shouldNotAcceptNullConfig() {
-        var queryTask = new InternalExecuteQueryBuilder(mock(Driver.class), new Query("string"), ExecuteQueryConfig.defaultConfig());
+        var queryTask = new InternalExecuteQueryTemplate(mock(Driver.class), new Query("string"), ExecuteQueryConfig.defaultConfig());
         assertThrows(NullPointerException.class, () -> queryTask.withConfig(null));
     }
 
     @Test
     void shouldUpdateConfig() {
         // GIVEN
         var query = new Query("string");
-        var queryTask = new InternalExecuteQueryBuilder(mock(Driver.class), query, ExecuteQueryConfig.defaultConfig());
+        var queryTask = new InternalExecuteQueryTemplate(mock(Driver.class), query, ExecuteQueryConfig.defaultConfig());
         var config = ExecuteQueryConfig.builder().withDatabase("database").build();
 
         // WHEN
-        queryTask = (InternalExecuteQueryBuilder) queryTask.withConfig(config);
+        queryTask = (InternalExecuteQueryTemplate) queryTask.withConfig(config);
 
         // THEN
         assertEquals(config, queryTask.config());
@@ -156,11 +156,11 @@ var record = mock(Record.class);
         Function<Object, String> finisher = mock(Function.class);
         given(finisher.apply(resultContainer)).willReturn(collectorResult);
         given(recordCollector.finisher()).willReturn(finisher);
-        ExecuteQueryBuilder.ResultFinisher<String, String> finisherWithSummary = mock(ExecuteQueryBuilder.ResultFinisher.class);
+        ExecuteQueryTemplate.ResultFinisher<String, String> finisherWithSummary = mock(ExecuteQueryTemplate.ResultFinisher.class);
         var expectedExecuteResult = "1";
         given(finisherWithSummary.finish(any(List.class), any(String.class), any(ResultSummary.class)))
                 .willReturn(expectedExecuteResult);
-        var queryTask = new InternalExecuteQueryBuilder(driver, query, config).withParameters(params);
+        var queryTask = new InternalExecuteQueryTemplate(driver, query, config).withParameters(params);
 
         // WHEN
         var executeResult = queryTask.execute(recordCollector, finisherWithSummary);

testkit-backend/src/main/java/neo4j/org/testkit/backend/messages/requests/ExecuteQuery.java

@@ -65,7 +65,7 @@ public TestkitResponse process(TestkitState testkitState) {
             configBuilder.withBookmarkManager(bookmarkManager);
         }
         var params = data.getParams() != null ? data.getParams() : Collections.<String, Object>emptyMap();
-        var eagerResult = driver.executeQueryBuilder(data.getCypher())
+        var eagerResult = driver.executeQueryTemplate(data.getCypher())
                 .withParameters(params)
                 .withConfig(configBuilder.build())
                 .execute();