Skip to content

Commit cfb39ac

Browse files
marcwrobelsbrannen
authored andcommitted
Fix and improve Javadoc in spring-r2dbc
See gh-28796
1 parent 222dbf8 commit cfb39ac

File tree

9 files changed

+19
-19
lines changed

9 files changed

+19
-19
lines changed

spring-r2dbc/src/main/java/org/springframework/r2dbc/connection/R2dbcTransactionManager.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ public R2dbcTransactionManager(ConnectionFactory connectionFactory) {
107107

108108
/**
109109
* Set the R2DBC {@link ConnectionFactory} that this instance should manage transactions for.
110-
* <p>This will typically be a locally defined {@code ConnectionFactory}, for example an connection pool.
110+
* <p>This will typically be a locally defined {@code ConnectionFactory}, for example a connection pool.
111111
* <p><b>The {@code ConnectionFactory} passed in here needs to return independent {@link Connection}s.</b>
112112
* The {@code Connection}s may come from a pool (the typical case), but the {@code ConnectionFactory}
113113
* must not return scoped {@code Connection}s or the like.
@@ -138,7 +138,7 @@ protected ConnectionFactory obtainConnectionFactory() {
138138

139139
/**
140140
* Specify whether to enforce the read-only nature of a transaction (as indicated by
141-
* {@link TransactionDefinition#isReadOnly()} through an explicit statement on the
141+
* {@link TransactionDefinition#isReadOnly()}) through an explicit statement on the
142142
* transactional connection: "SET TRANSACTION READ ONLY" as understood by Oracle,
143143
* MySQL and Postgres.
144144
* <p>The exact treatment, including any SQL statement executed on the connection,

spring-r2dbc/src/main/java/org/springframework/r2dbc/connection/init/ScriptUtils.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -166,9 +166,9 @@ public static Mono<Void> executeSqlScript(Connection connection, EncodedResource
166166
* @param resource the resource (potentially associated with a specific encoding)
167167
* to load the SQL script from
168168
* @param dataBufferFactory the factory to create data buffers with
169-
* @param continueOnError whether or not to continue without throwing an exception
169+
* @param continueOnError whether to continue without throwing an exception
170170
* in the event of an error
171-
* @param ignoreFailedDrops whether or not to continue in the event of specifically
171+
* @param ignoreFailedDrops whether to continue in the event of specifically
172172
* an error on a {@code DROP} statement
173173
* @param commentPrefix the prefix that identifies single-line comments in the
174174
* SQL script (typically "--")
@@ -207,9 +207,9 @@ public static Mono<Void> executeSqlScript(Connection connection, EncodedResource
207207
* @param resource the resource (potentially associated with a specific encoding)
208208
* to load the SQL script from
209209
* @param dataBufferFactory the factory to create data buffers with
210-
* @param continueOnError whether or not to continue without throwing an exception
210+
* @param continueOnError whether to continue without throwing an exception
211211
* in the event of an error
212-
* @param ignoreFailedDrops whether or not to continue in the event of specifically
212+
* @param ignoreFailedDrops whether to continue in the event of specifically
213213
* an error on a {@code DROP} statement
214214
* @param commentPrefixes the prefixes that identify single-line comments in the
215215
* SQL script (typically "--")

spring-r2dbc/src/main/java/org/springframework/r2dbc/core/ConnectionAccessor.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ public interface ConnectionAccessor {
4545
* Execute a callback {@link Function} within a {@link Connection} scope.
4646
* The function is responsible for creating a {@link Mono}. The connection
4747
* is released after the {@link Mono} terminates (or the subscription
48-
* is cancelled). Connection resources must not be passed outside of the
48+
* is cancelled). Connection resources must not be passed outside the
4949
* {@link Function} closure, otherwise resources may get defunct.
5050
* @param action the callback object that specifies the connection action
5151
* @return the resulting {@link Mono}
@@ -56,7 +56,7 @@ public interface ConnectionAccessor {
5656
* Execute a callback {@link Function} within a {@link Connection} scope.
5757
* The function is responsible for creating a {@link Flux}. The connection
5858
* is released after the {@link Flux} terminates (or the subscription
59-
* is cancelled). Connection resources must not be passed outside of the
59+
* is cancelled). Connection resources must not be passed outside the
6060
* {@link Function} closure, otherwise resources may get defunct.
6161
* @param action the callback object that specifies the connection action
6262
* @return the resulting {@link Flux}

spring-r2dbc/src/main/java/org/springframework/r2dbc/core/Parameter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ public boolean hasValue() {
100100
}
101101

102102
/**
103-
* Return whether this {@link Parameter} has a empty.
103+
* Return whether this {@link Parameter} has an empty value.
104104
* @return {@code true} if {@link #getValue()} is {@code null}
105105
*/
106106
public boolean isEmpty() {

spring-r2dbc/src/main/java/org/springframework/r2dbc/core/ParsedSql.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ void addNamedParameter(String parameterName, int startIndex, int endIndex) {
6969
}
7070

7171
/**
72-
* Return all of the parameters (bind variables) in the parsed SQL statement.
72+
* Return all the parameters (bind variables) in the parsed SQL statement.
7373
* Repeated occurrences of the same parameter name are included here.
7474
*/
7575
List<String> getParameterNames() {
@@ -81,7 +81,7 @@ List<String> getParameterNames() {
8181
* @param parameterPosition the position of the parameter
8282
* (as index in the parameter names List)
8383
* @return the start index and end index, combined into
84-
* a int array of length 2
84+
* an int array of length 2
8585
*/
8686
int[] getParameterIndexes(int parameterPosition) {
8787
return this.parameterIndexes.get(parameterPosition);
@@ -104,29 +104,29 @@ int getNamedParameterCount() {
104104
}
105105

106106
/**
107-
* Set the count of all of the unnamed parameters in the SQL statement.
107+
* Set the count of all the unnamed parameters in the SQL statement.
108108
*/
109109
void setUnnamedParameterCount(int unnamedParameterCount) {
110110
this.unnamedParameterCount = unnamedParameterCount;
111111
}
112112

113113
/**
114-
* Return the count of all of the unnamed parameters in the SQL statement.
114+
* Return the count of all the unnamed parameters in the SQL statement.
115115
*/
116116
int getUnnamedParameterCount() {
117117
return this.unnamedParameterCount;
118118
}
119119

120120
/**
121-
* Set the total count of all of the parameters in the SQL statement.
121+
* Set the total count of all the parameters in the SQL statement.
122122
* Repeated occurrences of the same parameter name do count here.
123123
*/
124124
void setTotalParameterCount(int totalParameterCount) {
125125
this.totalParameterCount = totalParameterCount;
126126
}
127127

128128
/**
129-
* Return the total count of all of the parameters in the SQL statement.
129+
* Return the total count of all the parameters in the SQL statement.
130130
* Repeated occurrences of the same parameter name do count here.
131131
*/
132132
int getTotalParameterCount() {

spring-r2dbc/src/main/java/org/springframework/r2dbc/core/StatementFilterFunction.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ public interface StatementFilterFunction {
4848
/**
4949
* Apply this filter to the given {@link Statement} and {@link ExecuteFunction}.
5050
* <p>The given {@link ExecuteFunction} represents the next entity in the chain,
51-
* to be invoked via {@link ExecuteFunction#execute(Statement)} invoked} in
51+
* to be invoked via {@link ExecuteFunction#execute(Statement)} in
5252
* order to proceed with the execution, or not invoked to shortcut the chain.
5353
* @param statement the current {@link Statement}
5454
* @param next the next execute function in the chain

spring-r2dbc/src/main/java/org/springframework/r2dbc/core/binding/AnonymousBindMarkers.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* the placeholder. This implementation creates indexed bind markers using
2525
* an anonymous placeholder that correlates with an index.
2626
*
27-
* <p>Note: Anonymous bind markers are problematic because the have to appear
27+
* <p>Note: Anonymous bind markers are problematic because they have to appear
2828
* in generated SQL in the same order they get generated. This might cause
2929
* challenges in the future with complex generate statements. For example those
3030
* containing subselects which limit the freedom of arranging bind markers.

spring-r2dbc/src/main/java/org/springframework/r2dbc/core/binding/Bindings.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ public BindMarker getBindMarker() {
167167

168168
/**
169169
* Return whether the binding is empty.
170-
* @return {@code true} if this is is a {@code NULL} binding
170+
* @return {@code true} if this is a {@code NULL} binding
171171
*/
172172
public boolean isNull() {
173173
return !hasValue();

spring-r2dbc/src/test/java/org/springframework/r2dbc/core/DefaultDatabaseClientUnitTests.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,7 @@ private MockResult mockSingleColumnEmptyResult() {
428428
}
429429

430430
/**
431-
* Mocks a {@link Result} with a single column "name" and a single row if a non null
431+
* Mocks a {@link Result} with a single column "name" and a single row if a non-null
432432
* row is provided.
433433
*/
434434
private MockResult mockSingleColumnResult(@Nullable MockRow.Builder row) {

0 commit comments

Comments
 (0)