Polishing

Minor doc fixes. Add Javadoc, align license headers to comply with inlined Spring Framework code.

Author: mp911de

src/main/asciidoc/reference/r2dbc.adoc

@@ -463,12 +463,12 @@ R2DBC uses database-native bind markers that depend on the actual database.
 If you are familiar with JDBC, then you're also familiar with `?` (question mark) bind markers.
 JDBC drivers translate question mark bind markers to database-native markers as part of statement execution.
 
-Postgres uses `$1`, `$2` and so on, SQL Server uses named bind markers prefixed with `@` as their native bind markers.
-Spring Data R2DBC leverages `Dialect` implementations to expand named parameters to native bind markers at the time of query execution which gives you a certain degree of query portability across various database vendors
+Postgres uses indexed markers (`$1`, `$2`), SQL Server uses named bind markers prefixed with `@` as its native bind marker syntax.
+Spring Data R2DBC leverages `Dialect` implementations to expand named parameters to native bind markers at the time of query execution which gives you a certain degree of query portability across various database vendors.
 You can still use native bind markers if you prefer to do so.
 ****
 
-The query-preprocessor unrolls named `Collection` parameters to remove the need of dynamic query creation based on the number of arguments.
+The query-preprocessor unrolls named `Collection` parameters into a series of bind markers to remove the need of dynamic query creation based on the number of arguments.
 Nested object arrays are expanded to allow usage of e.g. select lists.
 
 Consider the following query:

src/main/java/org/springframework/data/r2dbc/function/BindParameterSource.java

@@ -19,7 +19,7 @@
 
 /**
  * Interface that defines common functionality for objects that can offer parameter values for named bind parameters,
- * serving as argument for {@link NamedParameterSupport} operations.
+ * serving as argument for {@link NamedParameterExpander} operations.
  * <p>
  * This interface allows for the specification of the type in addition to parameter values. All parameter values and
  * types are identified by specifying the name of the parameter.
@@ -35,15 +35,15 @@ public interface BindParameterSource {
 	 * Determine whether there is a value for the specified named parameter.
 	 *
 	 * @param paramName the name of the parameter.
-	 * @return whether there is a value defined.
+	 * @return {@literal true} if there is a value defined; {@literal false} otherwise.
 	 */
 	boolean hasValue(String paramName);
 
 	/**
 	 * Return the parameter value for the requested named parameter.
 	 *
 	 * @param paramName the name of the parameter.
-	 * @return the value of the specified parameter.
+	 * @return the value of the specified parameter, can be {@literal null}.
 	 * @throws IllegalArgumentException if there is no value for the requested parameter.
 	 */
 	@Nullable

src/main/java/org/springframework/data/r2dbc/function/DatabaseClient.java

@@ -110,14 +110,14 @@ interface Builder {
 		Builder dataAccessStrategy(ReactiveDataAccessStrategy accessStrategy);
 
 		/**
-		 * Configures {@link NamedParameterSupport}.
+		 * Configures {@link NamedParameterExpander}.
 		 *
-		 * @param namedParameterSupport must not be {@literal null}.
+		 * @param namedParameters must not be {@literal null}.
 		 * @return {@code this} {@link Builder}.
-		 * @see NamedParameterSupport#enabled()
-		 * @see NamedParameterSupport#disabled()
+		 * @see NamedParameterExpander#enabled()
+		 * @see NamedParameterExpander#disabled()
 		 */
-		Builder namedParameters(NamedParameterSupport namedParameterSupport);
+		Builder namedParameters(NamedParameterExpander namedParameters);
 
 		/**
 		 * Configures a {@link Consumer} to configure this builder.
@@ -136,10 +136,10 @@ interface Builder {
 	/**
 	 * Contract for specifying a SQL call along with options leading to the exchange. The SQL string can contain either
 	 * native parameter bind markers (e.g. {@literal $1, $2} for Postgres, {@literal @P0, @P1} for SQL Server) or named
-	 * parameters (e.g. {@literal :foo, :bar}) when {@link NamedParameterSupport} is enabled.
+	 * parameters (e.g. {@literal :foo, :bar}) when {@link NamedParameterExpander} is enabled.
 	 *
-	 * @see NamedParameterSupport
-	 * @see DatabaseClient.Builder#namedParameters(NamedParameterSupport)
+	 * @see NamedParameterExpander
+	 * @see DatabaseClient.Builder#namedParameters(NamedParameterExpander)
 	 */
 	interface SqlSpec {
 

src/main/java/org/springframework/data/r2dbc/function/DefaultDatabaseClient.java

@@ -74,18 +74,18 @@ class DefaultDatabaseClient implements DatabaseClient, ConnectionAccessor {
 
 	private final ReactiveDataAccessStrategy dataAccessStrategy;
 
-	private final NamedParameterSupport namedParameterSupport;
+	private final NamedParameterExpander namedParameters;
 
 	private final DefaultDatabaseClientBuilder builder;
 
 	DefaultDatabaseClient(ConnectionFactory connector, R2dbcExceptionTranslator exceptionTranslator,
-			ReactiveDataAccessStrategy dataAccessStrategy, NamedParameterSupport namedParameterSupport,
+			ReactiveDataAccessStrategy dataAccessStrategy, NamedParameterExpander namedParameters,
 			DefaultDatabaseClientBuilder builder) {
 
 		this.connector = connector;
 		this.exceptionTranslator = exceptionTranslator;
 		this.dataAccessStrategy = dataAccessStrategy;
-		this.namedParameterSupport = namedParameterSupport;
+		this.namedParameters = namedParameters;
 		this.builder = builder;
 	}
 
@@ -326,7 +326,7 @@ <T> FetchSpec<T> exchange(String sql, BiFunction<Row, RowMetadata, T> mappingFun
 					logger.debug("Executing SQL statement [" + sql + "]");
 				}
 
-				BindableOperation operation = namedParameterSupport.expand(sql, dataAccessStrategy.getBindMarkersFactory(),
+				BindableOperation operation = namedParameters.expand(sql, dataAccessStrategy.getBindMarkersFactory(),
 						new MapBindParameterSource(byName));
 
 				Statement<?> statement = it.createStatement(operation.toQuery());

src/main/java/org/springframework/data/r2dbc/function/DefaultDatabaseClientBuilder.java

@@ -38,7 +38,7 @@ class DefaultDatabaseClientBuilder implements DatabaseClient.Builder {
 	private @Nullable ConnectionFactory connectionFactory;
 	private @Nullable R2dbcExceptionTranslator exceptionTranslator;
 	private ReactiveDataAccessStrategy accessStrategy;
-	private NamedParameterSupport namedParameterSupport;
+	private NamedParameterExpander namedParameters;
 
 	DefaultDatabaseClientBuilder() {}
 
@@ -49,9 +49,13 @@ class DefaultDatabaseClientBuilder implements DatabaseClient.Builder {
 		this.connectionFactory = other.connectionFactory;
 		this.exceptionTranslator = other.exceptionTranslator;
 		this.accessStrategy = other.accessStrategy;
-		this.namedParameterSupport = other.namedParameterSupport;
+		this.namedParameters = other.namedParameters;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.r2dbc.function.DatabaseClient.Builder#connectionFactory(io.r2dbc.spi.ConnectionFactory)
+	 */
 	@Override
 	public Builder connectionFactory(ConnectionFactory factory) {
 
@@ -61,6 +65,10 @@ public Builder connectionFactory(ConnectionFactory factory) {
 		return this;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.r2dbc.function.DatabaseClient.Builder#exceptionTranslator(org.springframework.data.r2dbc.support.R2dbcExceptionTranslator)
+	 */
 	@Override
 	public Builder exceptionTranslator(R2dbcExceptionTranslator exceptionTranslator) {
 
@@ -70,6 +78,10 @@ public Builder exceptionTranslator(R2dbcExceptionTranslator exceptionTranslator)
 		return this;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.r2dbc.function.DatabaseClient.Builder#dataAccessStrategy(org.springframework.data.r2dbc.function.ReactiveDataAccessStrategy)
+	 */
 	@Override
 	public Builder dataAccessStrategy(ReactiveDataAccessStrategy accessStrategy) {
 
@@ -79,15 +91,23 @@ public Builder dataAccessStrategy(ReactiveDataAccessStrategy accessStrategy) {
 		return this;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.r2dbc.function.DatabaseClient.Builder#namedParameters(org.springframework.data.r2dbc.function.NamedParameterExpander)
+	 */
 	@Override
-	public Builder namedParameters(NamedParameterSupport namedParameterSupport) {
+	public Builder namedParameters(NamedParameterExpander namedParameters) {
 
-		Assert.notNull(namedParameterSupport, "NamedParameterSupportAccessStrategy must not be null!");
+		Assert.notNull(namedParameters, "NamedParameterExpander must not be null!");
 
-		this.namedParameterSupport = namedParameterSupport;
+		this.namedParameters = namedParameters;
 		return this;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.r2dbc.function.DatabaseClient.Builder#build()
+	 */
 	@Override
 	public DatabaseClient build() {
 
@@ -108,27 +128,35 @@ public DatabaseClient build() {
 			accessStrategy = new DefaultReactiveDataAccessStrategy(dialect);
 		}
 
-		NamedParameterSupport namedParameterSupport = this.namedParameterSupport;
+		NamedParameterExpander namedParameters = this.namedParameters;
 
-		if (namedParameterSupport == null) {
-			namedParameterSupport = NamedParameterSupport.enabled();
+		if (namedParameters == null) {
+			namedParameters = NamedParameterExpander.enabled();
 		}
 
-		return doBuild(this.connectionFactory, exceptionTranslator, accessStrategy, namedParameterSupport,
+		return doBuild(this.connectionFactory, exceptionTranslator, accessStrategy, namedParameters,
 				new DefaultDatabaseClientBuilder(this));
 	}
 
 	protected DatabaseClient doBuild(ConnectionFactory connector, R2dbcExceptionTranslator exceptionTranslator,
-			ReactiveDataAccessStrategy accessStrategy, NamedParameterSupport namedParameterSupport,
+			ReactiveDataAccessStrategy accessStrategy, NamedParameterExpander namedParameters,
 			DefaultDatabaseClientBuilder builder) {
-		return new DefaultDatabaseClient(connector, exceptionTranslator, accessStrategy, namedParameterSupport, builder);
+		return new DefaultDatabaseClient(connector, exceptionTranslator, accessStrategy, namedParameters, builder);
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see java.lang.Object#clone()
+	 */
 	@Override
 	public DatabaseClient.Builder clone() {
 		return new DefaultDatabaseClientBuilder(this);
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.r2dbc.function.DatabaseClient.Builder#apply(java.util.function.Consumer)
+	 */
 	@Override
 	public DatabaseClient.Builder apply(Consumer<DatabaseClient.Builder> builderConsumer) {
 		Assert.notNull(builderConsumer, "BuilderConsumer must not be null");

src/main/java/org/springframework/data/r2dbc/function/DefaultTransactionalDatabaseClient.java

@@ -39,9 +39,9 @@
 class DefaultTransactionalDatabaseClient extends DefaultDatabaseClient implements TransactionalDatabaseClient {
 
 	DefaultTransactionalDatabaseClient(ConnectionFactory connector, R2dbcExceptionTranslator exceptionTranslator,
-			ReactiveDataAccessStrategy dataAccessStrategy, NamedParameterSupport namedParameterSupport,
+			ReactiveDataAccessStrategy dataAccessStrategy, NamedParameterExpander namedParameters,
 			DefaultDatabaseClientBuilder builder) {
-		super(connector, exceptionTranslator, dataAccessStrategy, namedParameterSupport, builder);
+		super(connector, exceptionTranslator, dataAccessStrategy, namedParameters, builder);
 	}
 
 	@Override

src/main/java/org/springframework/data/r2dbc/function/DefaultTransactionalDatabaseClientBuilder.java

@@ -73,8 +73,8 @@ public TransactionalDatabaseClient.Builder dataAccessStrategy(ReactiveDataAccess
 	 * @see org.springframework.data.r2dbc.function.DefaultDatabaseClientBuilder#dataAccessStrategy(org.springframework.data.r2dbc.function.NamedParameterSupport)
 	 */
 	@Override
-	public TransactionalDatabaseClient.Builder namedParameters(NamedParameterSupport namedParameterSupport) {
-		super.namedParameters(namedParameterSupport);
+	public TransactionalDatabaseClient.Builder namedParameters(NamedParameterExpander namedParameters) {
+		super.namedParameters(namedParameters);
 		return this;
 	}
 
@@ -97,9 +97,9 @@ public TransactionalDatabaseClient build() {
 
 	@Override
 	protected DatabaseClient doBuild(ConnectionFactory connector, R2dbcExceptionTranslator exceptionTranslator,
-			ReactiveDataAccessStrategy accessStrategy, NamedParameterSupport namedParameterSupport,
+			ReactiveDataAccessStrategy accessStrategy, NamedParameterExpander namedParameters,
 			DefaultDatabaseClientBuilder builder) {
-		return new DefaultTransactionalDatabaseClient(connector, exceptionTranslator, accessStrategy, namedParameterSupport,
+		return new DefaultTransactionalDatabaseClient(connector, exceptionTranslator, accessStrategy, namedParameters,
 				builder);
 	}
 }

src/main/java/org/springframework/data/r2dbc/function/MapBindParameterSource.java

@@ -26,7 +26,7 @@
  * {@link SettableValue}.
  * <p>
  * This class is intended for passing in a simple Map of parameter values to the methods of the
- * {@link NamedParameterSupport} class.
+ * {@link NamedParameterExpander} class.
  *
  * @author Mark Paluch
  */

src/main/java/org/springframework/data/r2dbc/function/NamedParameterSupport.java renamed to src/main/java/org/springframework/data/r2dbc/function/NamedParameterExpander.java

@@ -34,7 +34,7 @@
  *
  * @author Mark Paluch
  */
-public class NamedParameterSupport {
+public class NamedParameterExpander {
 
 	/** Default maximum number of entries for the SQL cache: 256. */
 	public static final int DEFAULT_CACHE_LIMIT = 256;
@@ -52,24 +52,24 @@ protected boolean removeEldestEntry(Map.Entry<String, ParsedSql> eldest) {
 		}
 	};
 
-	private NamedParameterSupport() {}
+	private NamedParameterExpander() {}
 
 	/**
-	 * Creates a disabled instance of {@link NamedParameterSupport}.
+	 * Creates a disabled instance of {@link NamedParameterExpander}.
 	 *
-	 * @return a disabled instance of {@link NamedParameterSupport}.
+	 * @return a disabled instance of {@link NamedParameterExpander}.
 	 */
-	public static NamedParameterSupport disabled() {
+	public static NamedParameterExpander disabled() {
 		return Disabled.INSTANCE;
 	}
 
 	/**
-	 * Creates a new enabled instance of {@link NamedParameterSupport}.
+	 * Creates a new enabled instance of {@link NamedParameterExpander}.
 	 *
-	 * @return a new enabled instance of {@link NamedParameterSupport}.
+	 * @return a new enabled instance of {@link NamedParameterExpander}.
 	 */
-	public static NamedParameterSupport enabled() {
-		return new NamedParameterSupport();
+	public static NamedParameterExpander enabled() {
+		return new NamedParameterExpander();
 	}
 
 	/**
@@ -127,7 +127,7 @@ BindableOperation expand(String sql, BindMarkersFactory bindMarkersFactory, Bind
 	/**
 	 * Disabled named parameter support.
 	 */
-	static class Disabled extends NamedParameterSupport {
+	static class Disabled extends NamedParameterExpander {
 
 		private static final Disabled INSTANCE = new Disabled();
 

src/main/java/org/springframework/data/r2dbc/function/NamedParameterUtils.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package org.springframework.data.r2dbc.function;
 
 import io.r2dbc.spi.Statement;
@@ -39,7 +38,11 @@
  * <p>
  * Only intended for internal use within Spring's Data's R2DBC framework. Partially extracted from Spring's JDBC named
  * parameter support.
+ * <p>
+ * This is a subset of Spring Frameworks's {@code org.springframework.jdbc.core.namedparam.NamedParameterUtils}.
  *
+ * @author Thomas Risberg
+ * @author Juergen Hoeller
  * @author Mark Paluch
  */
 abstract class NamedParameterUtils {

src/main/java/org/springframework/data/r2dbc/function/ParsedSql.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,14 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package org.springframework.data.r2dbc.function;
 
 import java.util.ArrayList;
 import java.util.List;
 
 /**
  * Holds information about a parsed SQL statement.
+ * <p>
+ * This is a copy of Spring Frameworks's {@code org.springframework.jdbc.core.namedparam.ParsedSql}.
  *
  * @author Thomas Risberg
  * @author Juergen Hoeller

src/main/java/org/springframework/data/r2dbc/function/TransactionalDatabaseClient.java

@@ -190,14 +190,14 @@ interface Builder extends DatabaseClient.Builder {
 		Builder dataAccessStrategy(ReactiveDataAccessStrategy accessStrategy);
 
 		/**
-		 * Configures {@link NamedParameterSupport}.
+		 * Configures {@link NamedParameterExpander}.
 		 *
-		 * @param namedParameterSupport must not be {@literal null}.
+		 * @param namedParameters must not be {@literal null}.
 		 * @return {@code this} {@link Builder}.
-		 * @see NamedParameterSupport#enabled()
-		 * @see NamedParameterSupport#disabled()
+		 * @see NamedParameterExpander#enabled()
+		 * @see NamedParameterExpander#disabled()
 		 */
-		Builder namedParameters(NamedParameterSupport namedParameterSupport);
+		Builder namedParameters(NamedParameterExpander namedParameters);
 
 		/**
 		 * Configures a {@link Consumer} to configure this builder.