JAVA-2164: Rename statement builder methods to setXxx

apache · Mar 7, 2019 · 3b7d300 · 3b7d300
1 parent 0e51bcb
commit 3b7d300
Show file tree

Hide file tree

Showing 38 changed files with 253 additions and 132 deletions.
diff --git a/changelog/README.md b/changelog/README.md
@@ -4,6 +4,7 @@
 
 ### 4.0.0 (in progress)
 
+- [improvement] JAVA-2164: Rename statement builder methods to setXxx
 - [bug] JAVA-2178: QueryBuilder: Alias after function column is not included in a query
 - [improvement] JAVA-2158: Allow BuildableQuery to build statement with values
 - [improvement] JAVA-2150: Improve query builder error message on unsupported literal type

diff --git a/core/revapi.json b/core/revapi.json
@@ -15,6 +15,126 @@
       }
     },
     "ignore": [
+      {
+        "code": "java.method.removed",
+        "old": "method com.datastax.oss.driver.api.core.cql.BatchStatementBuilder com.datastax.oss.driver.api.core.cql.BatchStatementBuilder::withKeyspace(com.datastax.oss.driver.api.core.CqlIdentifier)",
+        "oldArchive": "com.datastax.oss:java-driver-core:jar:4.0.0-rc1",
+        "justification": "JAVA-2164: Rename statement builder methods to setXxx"
+      },
+      {
+        "code": "java.method.removed",
+        "old": "method com.datastax.oss.driver.api.core.cql.BatchStatementBuilder com.datastax.oss.driver.api.core.cql.BatchStatementBuilder::withKeyspace(java.lang.String)",
+        "oldArchive": "com.datastax.oss:java-driver-core:jar:4.0.0-rc1",
+        "justification": "JAVA-2164: Rename statement builder methods to setXxx"
+      },
+      {
+        "code": "java.method.removed",
+        "old": "method com.datastax.oss.driver.api.core.cql.SimpleStatementBuilder com.datastax.oss.driver.api.core.cql.SimpleStatementBuilder::withKeyspace(com.datastax.oss.driver.api.core.CqlIdentifier)",
+        "oldArchive": "com.datastax.oss:java-driver-core:jar:4.0.0-rc1",
+        "justification": "JAVA-2164: Rename statement builder methods to setXxx"
+      },
+      {
+        "code": "java.method.removed",
+        "old": "method com.datastax.oss.driver.api.core.cql.SimpleStatementBuilder com.datastax.oss.driver.api.core.cql.SimpleStatementBuilder::withKeyspace(java.lang.String)",
+        "oldArchive": "com.datastax.oss:java-driver-core:jar:4.0.0-rc1",
+        "justification": "JAVA-2164: Rename statement builder methods to setXxx"
+      },
+      {
+        "code": "java.method.removed",
+        "old": "method com.datastax.oss.driver.api.core.cql.SimpleStatementBuilder com.datastax.oss.driver.api.core.cql.SimpleStatementBuilder::withQuery(java.lang.String)",
+        "oldArchive": "com.datastax.oss:java-driver-core:jar:4.0.0-rc1",
+        "justification": "JAVA-2164: Rename statement builder methods to setXxx"
+      },
+      {
+        "code": "java.method.removed",
+        "old": "method SelfT com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>, StatementT>, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>>::withConsistencyLevel(com.datastax.oss.driver.api.core.ConsistencyLevel)",
+        "oldArchive": "com.datastax.oss:java-driver-core:jar:4.0.0-rc1",
+        "justification": "JAVA-2164: Rename statement builder methods to setXxx"
+      },
+      {
+        "code": "java.method.removed",
+        "old": "method SelfT com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>, StatementT>, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>>::withExecutionProfile(com.datastax.oss.driver.api.core.config.DriverExecutionProfile)",
+        "oldArchive": "com.datastax.oss:java-driver-core:jar:4.0.0-rc1",
+        "justification": "JAVA-2164: Rename statement builder methods to setXxx"
+      },
+      {
+        "code": "java.method.removed",
+        "old": "method SelfT com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>, StatementT>, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>>::withExecutionProfileName(java.lang.String)",
+        "oldArchive": "com.datastax.oss:java-driver-core:jar:4.0.0-rc1",
+        "justification": "JAVA-2164: Rename statement builder methods to setXxx"
+      },
+      {
+        "code": "java.method.removed",
+        "old": "method SelfT com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>, StatementT>, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>>::withIdempotence(java.lang.Boolean)",
+        "oldArchive": "com.datastax.oss:java-driver-core:jar:4.0.0-rc1",
+        "justification": "JAVA-2164: Rename statement builder methods to setXxx"
+      },
+      {
+        "code": "java.method.removed",
+        "old": "method SelfT com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>, StatementT>, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>>::withNode(com.datastax.oss.driver.api.core.metadata.Node)",
+        "oldArchive": "com.datastax.oss:java-driver-core:jar:4.0.0-rc1",
+        "justification": "JAVA-2164: Rename statement builder methods to setXxx"
+      },
+      {
+        "code": "java.method.removed",
+        "old": "method SelfT com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>, StatementT>, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>>::withPageSize(int)",
+        "oldArchive": "com.datastax.oss:java-driver-core:jar:4.0.0-rc1",
+        "justification": "JAVA-2164: Rename statement builder methods to setXxx"
+      },
+      {
+        "code": "java.method.removed",
+        "old": "method SelfT com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>, StatementT>, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>>::withPagingState(java.nio.ByteBuffer)",
+        "oldArchive": "com.datastax.oss:java-driver-core:jar:4.0.0-rc1",
+        "justification": "JAVA-2164: Rename statement builder methods to setXxx"
+      },
+      {
+        "code": "java.method.removed",
+        "old": "method SelfT com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>, StatementT>, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>>::withRoutingKey(java.nio.ByteBuffer)",
+        "oldArchive": "com.datastax.oss:java-driver-core:jar:4.0.0-rc1",
+        "justification": "JAVA-2164: Rename statement builder methods to setXxx"
+      },
+      {
+        "code": "java.method.removed",
+        "old": "method SelfT com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>, StatementT>, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>>::withRoutingKeyspace(com.datastax.oss.driver.api.core.CqlIdentifier)",
+        "oldArchive": "com.datastax.oss:java-driver-core:jar:4.0.0-rc1",
+        "justification": "JAVA-2164: Rename statement builder methods to setXxx"
+      },
+      {
+        "code": "java.method.removed",
+        "old": "method SelfT com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>, StatementT>, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>>::withRoutingKeyspace(java.lang.String)",
+        "oldArchive": "com.datastax.oss:java-driver-core:jar:4.0.0-rc1",
+        "justification": "JAVA-2164: Rename statement builder methods to setXxx"
+      },
+      {
+        "code": "java.method.removed",
+        "old": "method SelfT com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>, StatementT>, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>>::withRoutingToken(com.datastax.oss.driver.api.core.metadata.token.Token)",
+        "oldArchive": "com.datastax.oss:java-driver-core:jar:4.0.0-rc1",
+        "justification": "JAVA-2164: Rename statement builder methods to setXxx"
+      },
+      {
+        "code": "java.method.removed",
+        "old": "method SelfT com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>, StatementT>, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>>::withSerialConsistencyLevel(com.datastax.oss.driver.api.core.ConsistencyLevel)",
+        "oldArchive": "com.datastax.oss:java-driver-core:jar:4.0.0-rc1",
+        "justification": "JAVA-2164: Rename statement builder methods to setXxx"
+      },
+      {
+        "code": "java.method.removed",
+        "old": "method SelfT com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>, StatementT>, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>>::withTimeout(java.time.Duration)",
+        "oldArchive": "com.datastax.oss:java-driver-core:jar:4.0.0-rc1",
+        "justification": "JAVA-2164: Rename statement builder methods to setXxx"
+      },
+      {
+        "code": "java.method.removed",
+        "old": "method SelfT com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>, StatementT>, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>>::withTimestamp(long)",
+        "oldArchive": "com.datastax.oss:java-driver-core:jar:4.0.0-rc1",
+        "justification": "JAVA-2164: Rename statement builder methods to setXxx"
+      },
+      {
+        "code": "java.method.removed",
+        "old": "method SelfT com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT extends com.datastax.oss.driver.api.core.cql.StatementBuilder<SelfT, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>, StatementT>, StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT extends com.datastax.oss.driver.api.core.cql.Statement<StatementT>>>::withTracing()",
+        "oldArchive": "com.datastax.oss:java-driver-core:jar:4.0.0-rc1",
+        "justification": "JAVA-2164: Rename statement builder methods to setXxx"
+      }
     ]
   }
 }
diff --git a/core/src/main/java/com/datastax/oss/driver/api/core/cql/BatchStatementBuilder.java b/core/src/main/java/com/datastax/oss/driver/api/core/cql/BatchStatementBuilder.java
@@ -51,20 +51,20 @@ public BatchStatementBuilder(@NonNull BatchStatement template) {
    * @see BatchStatement#getKeyspace()
    */
   @NonNull
-  public BatchStatementBuilder withKeyspace(@NonNull CqlIdentifier keyspace) {
+  public BatchStatementBuilder setKeyspace(@NonNull CqlIdentifier keyspace) {
     this.keyspace = keyspace;
     return this;
   }
 
   /**
-   * Sets the CQL keyspace to execute this batch in. Shortcut for {@link
-   * #withKeyspace(CqlIdentifier) withKeyspace(CqlIdentifier.fromCql(keyspaceName))}.
+   * Sets the CQL keyspace to execute this batch in. Shortcut for {@link #setKeyspace(CqlIdentifier)
+   * setKeyspace(CqlIdentifier.fromCql(keyspaceName))}.
    *
    * @return this builder; never {@code null}.
    */
   @NonNull
-  public BatchStatementBuilder withKeyspace(@NonNull String keyspaceName) {
-    return withKeyspace(CqlIdentifier.fromCql(keyspaceName));
+  public BatchStatementBuilder setKeyspace(@NonNull String keyspaceName) {
+    return setKeyspace(CqlIdentifier.fromCql(keyspaceName));
   }
 
   /**

diff --git a/core/src/main/java/com/datastax/oss/driver/api/core/cql/SimpleStatementBuilder.java b/core/src/main/java/com/datastax/oss/driver/api/core/cql/SimpleStatementBuilder.java
@@ -61,25 +61,25 @@ public SimpleStatementBuilder(@NonNull SimpleStatement template) {
 
   /** @see SimpleStatement#getQuery() */
   @NonNull
-  public SimpleStatementBuilder withQuery(@NonNull String query) {
+  public SimpleStatementBuilder setQuery(@NonNull String query) {
     this.query = query;
     return this;
   }
 
   /** @see SimpleStatement#getKeyspace() */
   @NonNull
-  public SimpleStatementBuilder withKeyspace(@Nullable CqlIdentifier keyspace) {
+  public SimpleStatementBuilder setKeyspace(@Nullable CqlIdentifier keyspace) {
     this.keyspace = keyspace;
     return this;
   }
 
   /**
-   * Shortcut for {@link #withKeyspace(CqlIdentifier)
-   * withKeyspace(CqlIdentifier.fromCql(keyspaceName))}.
+   * Shortcut for {@link #setKeyspace(CqlIdentifier)
+   * setKeyspace(CqlIdentifier.fromCql(keyspaceName))}.
    */
   @NonNull
-  public SimpleStatementBuilder withKeyspace(@Nullable String keyspaceName) {
-    return withKeyspace(keyspaceName == null ? null : CqlIdentifier.fromCql(keyspaceName));
+  public SimpleStatementBuilder setKeyspace(@Nullable String keyspaceName) {
+    return setKeyspace(keyspaceName == null ? null : CqlIdentifier.fromCql(keyspaceName));
   }
 
   /** @see SimpleStatement#setPositionalValues(List) */

diff --git a/core/src/main/java/com/datastax/oss/driver/api/core/cql/StatementBuilder.java b/core/src/main/java/com/datastax/oss/driver/api/core/cql/StatementBuilder.java
@@ -86,46 +86,46 @@ protected StatementBuilder(StatementT template) {
 
   /** @see Statement#setExecutionProfileName(String) */
   @NonNull
-  public SelfT withExecutionProfileName(@Nullable String executionProfileName) {
+  public SelfT setExecutionProfileName(@Nullable String executionProfileName) {
     this.executionProfileName = executionProfileName;
     return self;
   }
 
   /** @see Statement#setExecutionProfile(DriverExecutionProfile) */
   @NonNull
-  public SelfT withExecutionProfile(@Nullable DriverExecutionProfile executionProfile) {
+  public SelfT setExecutionProfile(@Nullable DriverExecutionProfile executionProfile) {
     this.executionProfile = executionProfile;
     this.executionProfileName = null;
     return self;
   }
 
   /** @see Statement#setRoutingKeyspace(CqlIdentifier) */
   @NonNull
-  public SelfT withRoutingKeyspace(@Nullable CqlIdentifier routingKeyspace) {
+  public SelfT setRoutingKeyspace(@Nullable CqlIdentifier routingKeyspace) {
     this.routingKeyspace = routingKeyspace;
     return self;
   }
 
   /**
-   * Shortcut for {@link #withRoutingKeyspace(CqlIdentifier)
-   * withRoutingKeyspace(CqlIdentifier.fromCql(routingKeyspaceName))}.
+   * Shortcut for {@link #setRoutingKeyspace(CqlIdentifier)
+   * setRoutingKeyspace(CqlIdentifier.fromCql(routingKeyspaceName))}.
    */
   @NonNull
-  public SelfT withRoutingKeyspace(@Nullable String routingKeyspaceName) {
-    return withRoutingKeyspace(
+  public SelfT setRoutingKeyspace(@Nullable String routingKeyspaceName) {
+    return setRoutingKeyspace(
         routingKeyspaceName == null ? null : CqlIdentifier.fromCql(routingKeyspaceName));
   }
 
   /** @see Statement#setRoutingKey(ByteBuffer) */
   @NonNull
-  public SelfT withRoutingKey(@Nullable ByteBuffer routingKey) {
+  public SelfT setRoutingKey(@Nullable ByteBuffer routingKey) {
     this.routingKey = routingKey;
     return self;
   }
 
   /** @see Statement#setRoutingToken(Token) */
   @NonNull
-  public SelfT withRoutingToken(@Nullable Token routingToken) {
+  public SelfT setRoutingToken(@Nullable Token routingToken) {
     this.routingToken = routingToken;
     return self;
   }
@@ -149,62 +149,62 @@ public SelfT clearCustomPayload() {
 
   /** @see Statement#setIdempotent(Boolean) */
   @NonNull
-  public SelfT withIdempotence(@Nullable Boolean idempotent) {
+  public SelfT setIdempotence(@Nullable Boolean idempotent) {
     this.idempotent = idempotent;
     return self;
   }
 
   /** @see Statement#setTracing(boolean) */
   @NonNull
-  public SelfT withTracing() {
+  public SelfT setTracing() {
     this.tracing = true;
     return self;
   }
 
   /** @see Statement#setTimestamp(long) */
   @NonNull
-  public SelfT withTimestamp(long timestamp) {
+  public SelfT setTimestamp(long timestamp) {
     this.timestamp = timestamp;
     return self;
   }
 
   /** @see Statement#setPagingState(ByteBuffer) */
   @NonNull
-  public SelfT withPagingState(@Nullable ByteBuffer pagingState) {
+  public SelfT setPagingState(@Nullable ByteBuffer pagingState) {
     this.pagingState = pagingState;
     return self;
   }
 
   /** @see Statement#setPageSize(int) */
   @NonNull
-  public SelfT withPageSize(int pageSize) {
+  public SelfT setPageSize(int pageSize) {
     this.pageSize = pageSize;
     return self;
   }
 
   /** @see Statement#setConsistencyLevel(ConsistencyLevel) */
   @NonNull
-  public SelfT withConsistencyLevel(@Nullable ConsistencyLevel consistencyLevel) {
+  public SelfT setConsistencyLevel(@Nullable ConsistencyLevel consistencyLevel) {
     this.consistencyLevel = consistencyLevel;
     return self;
   }
 
   /** @see Statement#setSerialConsistencyLevel(ConsistencyLevel) */
   @NonNull
-  public SelfT withSerialConsistencyLevel(@Nullable ConsistencyLevel serialConsistencyLevel) {
+  public SelfT setSerialConsistencyLevel(@Nullable ConsistencyLevel serialConsistencyLevel) {
     this.serialConsistencyLevel = serialConsistencyLevel;
     return self;
   }
 
   /** @see Statement#setTimeout(Duration) */
   @NonNull
-  public SelfT withTimeout(@Nullable Duration timeout) {
+  public SelfT setTimeout(@Nullable Duration timeout) {
     this.timeout = timeout;
     return self;
   }
 
   /** @see Statement#setNode(Node) */
-  public SelfT withNode(@Nullable Node node) {
+  public SelfT setNode(@Nullable Node node) {
     this.node = node;
     return self;
   }

diff --git a/core/src/main/java/com/datastax/oss/driver/api/core/session/SessionBuilder.java b/core/src/main/java/com/datastax/oss/driver/api/core/session/SessionBuilder.java
@@ -259,7 +259,7 @@ public SelfT withKeyspace(@Nullable CqlIdentifier keyspace) {
 
   /**
    * Shortcut for {@link #withKeyspace(CqlIdentifier)
-   * withKeyspace(CqlIdentifier.fromCql(keyspaceName))}
+   * setKeyspace(CqlIdentifier.fromCql(keyspaceName))}
    */
   @NonNull
   public SelfT withKeyspace(@Nullable String keyspaceName) {