Skip to content

Commit 944577d

Browse files
committed
Polishing.
Fix javadoc. See #661
1 parent 245ad69 commit 944577d

10 files changed

+33
-33
lines changed

src/main/java/org/springframework/data/r2dbc/config/AbstractR2dbcConfiguration.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ public R2dbcMappingContext r2dbcMappingContext(Optional<NamingStrategy> namingSt
148148

149149
/**
150150
* Creates a {@link ReactiveDataAccessStrategy} using the configured
151-
* {@link #r2dbcConverter(Optional, R2dbcCustomConversions)} R2dbcConverter}.
151+
* {@link #r2dbcConverter(R2dbcMappingContext, R2dbcCustomConversions) R2dbcConverter}.
152152
*
153153
* @param converter the configured {@link R2dbcConverter}.
154154
* @return must not be {@literal null}.

src/main/java/org/springframework/data/r2dbc/connectionfactory/ConnectionProxy.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
/**
2222
* Sub interface of {@link Connection} to be implemented by Connection proxies. Allows access to the underlying target
2323
* Connection.
24-
* <p/>
24+
* <p>
2525
* This interface can be checked when there is a need to cast to a native R2DBC {@link Connection}.
2626
*
2727
* @author Mark Paluch
@@ -33,7 +33,7 @@ public interface ConnectionProxy extends Connection, Wrapped<Connection> {
3333

3434
/**
3535
* Return the target {@link Connection} of this proxy.
36-
* <p/>
36+
* <p>
3737
* This will typically be the native driver {@link Connection} or a wrapper from a connection pool.
3838
*
3939
* @return the underlying Connection (never {@literal null})

src/main/java/org/springframework/data/r2dbc/connectionfactory/init/ConnectionFactoryInitializer.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ public class ConnectionFactoryInitializer implements InitializingBean, Disposabl
4545
/**
4646
* The {@link ConnectionFactory} for the database to populate when this component is initialized and to clean up when
4747
* this component is shut down.
48-
* <p/>
48+
* <p>
4949
* This property is mandatory with no default provided.
5050
*
5151
* @param connectionFactory the R2DBC {@link ConnectionFactory}.

src/main/java/org/springframework/data/r2dbc/connectionfactory/init/ResourceDatabasePopulator.java

+9-9
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ public void setSqlScriptEncoding(@Nullable Charset sqlScriptEncoding) {
160160

161161
/**
162162
* Specify the statement separator, if a custom one.
163-
* <p/>
163+
* <p>
164164
* Defaults to {@code ";"} if not specified and falls back to {@code "\n"} as a last resort; may be set to
165165
* {@link ScriptUtils#EOF_STATEMENT_SEPARATOR} to signal that each script contains a single statement without a
166166
* separator.
@@ -173,7 +173,7 @@ public void setSeparator(String separator) {
173173

174174
/**
175175
* Set the prefix that identifies single-line comments within the SQL scripts.
176-
* <p/>
176+
* <p>
177177
* Defaults to {@code "--"}.
178178
*
179179
* @param commentPrefix the prefix for single-line comments
@@ -184,7 +184,7 @@ public void setCommentPrefix(String commentPrefix) {
184184

185185
/**
186186
* Set the start delimiter that identifies block comments within the SQL scripts.
187-
* <p/>
187+
* <p>
188188
* Defaults to {@code "/*"}.
189189
*
190190
* @param blockCommentStartDelimiter the start delimiter for block comments (never {@literal null} or empty).
@@ -199,7 +199,7 @@ public void setBlockCommentStartDelimiter(String blockCommentStartDelimiter) {
199199

200200
/**
201201
* Set the end delimiter that identifies block comments within the SQL scripts.
202-
* <p/>
202+
* <p>
203203
* Defaults to {@code "*&#47;"}.
204204
*
205205
* @param blockCommentEndDelimiter the end delimiter for block comments (never {@literal null} or empty)
@@ -214,7 +214,7 @@ public void setBlockCommentEndDelimiter(String blockCommentEndDelimiter) {
214214

215215
/**
216216
* Flag to indicate that all failures in SQL should be logged but not cause a failure.
217-
* <p/>
217+
* <p>
218218
* Defaults to {@literal false}.
219219
*
220220
* @param continueOnError {@literal true} if script execution should continue on error.
@@ -225,10 +225,10 @@ public void setContinueOnError(boolean continueOnError) {
225225

226226
/**
227227
* Flag to indicate that a failed SQL {@code DROP} statement can be ignored.
228-
* <p/>
228+
* <p>
229229
* This is useful for a non-embedded database whose SQL dialect does not support an {@code IF EXISTS} clause in a
230230
* {@code DROP} statement.
231-
* <p/>
231+
* <p>
232232
* The default is {@literal false} so that if the populator runs accidentally, it will fail fast if a script starts
233233
* with a {@code DROP} statement.
234234
*
@@ -240,7 +240,7 @@ public void setIgnoreFailedDrops(boolean ignoreFailedDrops) {
240240

241241
/**
242242
* Set the {@link DataBufferFactory} to use for {@link Resource} loading.
243-
* <p/>
243+
* <p>
244244
* Defaults to {@link DefaultDataBufferFactory}.
245245
*
246246
* @param dataBufferFactory the {@link DataBufferFactory} to use, must not be {@literal null}.
@@ -269,7 +269,7 @@ public Mono<Void> populate(Connection connection) throws ScriptException {
269269

270270
/**
271271
* Execute this {@link ResourceDatabasePopulator} against the given {@link ConnectionFactory}.
272-
* <p/>
272+
* <p>
273273
* Delegates to {@link DatabasePopulatorUtils#execute}.
274274
*
275275
* @param connectionFactory the {@link ConnectionFactory} to execute against, must not be {@literal null}..

src/main/java/org/springframework/data/r2dbc/connectionfactory/init/ScriptUtils.java

+14-14
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444

4545
/**
4646
* Generic utility methods for working with SQL scripts.
47-
* <p/>
47+
* <p>
4848
* Mainly for internal use within the framework.
4949
*
5050
* @author Mark Paluch
@@ -61,14 +61,14 @@ public abstract class ScriptUtils {
6161

6262
/**
6363
* Fallback statement separator within SQL scripts: {@code "\n"}.
64-
* <p/>
64+
* <p>
6565
* Used if neither a custom separator nor the {@link #DEFAULT_STATEMENT_SEPARATOR} is present in a given script.
6666
*/
6767
public static final String FALLBACK_STATEMENT_SEPARATOR = "\n";
6868

6969
/**
7070
* End of file (EOF) SQL statement separator: {@code "^^^ END OF SCRIPT ^^^"}.
71-
* <p/>
71+
* <p>
7272
* This value may be supplied as the {@code separator} to
7373
* {@link #executeSqlScript(Connection, EncodedResource, DataBufferFactory, boolean, boolean, String, String, String, String)}
7474
* to denote that an SQL script contains a single statement (potentially spanning multiple lines) with no explicit
@@ -100,7 +100,7 @@ private ScriptUtils() {}
100100
/**
101101
* Split an SQL script into separate statements delimited by the provided separator character. Each individual
102102
* statement will be added to the provided {@link List}.
103-
* <p/>
103+
* <p>
104104
* Within the script, {@value #DEFAULT_COMMENT_PREFIX} will be used as the comment prefix; any text beginning with the
105105
* comment prefix and extending to the end of the line will be omitted from the output. Similarly,
106106
* {@value #DEFAULT_BLOCK_COMMENT_START_DELIMITER} and {@value #DEFAULT_BLOCK_COMMENT_END_DELIMITER} will be used as
@@ -121,7 +121,7 @@ static void splitSqlScript(String script, char separator, List<String> statement
121121
/**
122122
* Split an SQL script into separate statements delimited by the provided separator string. Each individual statement
123123
* will be added to the provided {@link List}.
124-
* <p/>
124+
* <p>
125125
* Within the script, {@value #DEFAULT_COMMENT_PREFIX} will be used as the comment prefix; any text beginning with the
126126
* comment prefix and extending to the end of the line will be omitted from the output. Similarly,
127127
* {@value #DEFAULT_BLOCK_COMMENT_START_DELIMITER} and {@value #DEFAULT_BLOCK_COMMENT_END_DELIMITER} will be used as
@@ -143,7 +143,7 @@ static void splitSqlScript(String script, String separator, List<String> stateme
143143
/**
144144
* Split an SQL script into separate statements delimited by the provided separator string. Each individual statement
145145
* will be added to the provided {@link List}.
146-
* <p/>
146+
* <p>
147147
* Within the script, the provided {@code commentPrefix} will be honored: any text beginning with the comment prefix
148148
* and extending to the end of the line will be omitted from the output. Similarly, the provided
149149
* {@code blockCommentStartDelimiter} and {@code blockCommentEndDelimiter} delimiters will be honored: any text
@@ -255,7 +255,7 @@ public static Mono<String> readScript(EncodedResource resource, DataBufferFactor
255255
/**
256256
* Read a script without blocking from the provided resource, using the supplied comment prefix and statement
257257
* separator, and build a {@link String} and build a String containing the lines.
258-
* <p/>
258+
* <p>
259259
* Lines <em>beginning</em> with the comment prefix are excluded from the results; however, line comments anywhere
260260
* else &mdash; for example, within a statement &mdash; will be included in the results.
261261
*
@@ -291,7 +291,7 @@ private static Mono<String> readScript(EncodedResource resource, DataBufferFacto
291291
/**
292292
* Read a script from the provided {@link LineNumberReader}, using the supplied comment prefix and statement
293293
* separator, and build a {@link String} containing the lines.
294-
* <p/>
294+
* <p>
295295
* Lines <em>beginning</em> with the comment prefix are excluded from the results; however, line comments anywhere
296296
* else &mdash; for example, within a statement &mdash; will be included in the results.
297297
*
@@ -372,10 +372,10 @@ static boolean containsSqlScriptDelimiters(String script, String delim) {
372372
/**
373373
* Execute the given SQL script using default settings for statement separators, comment delimiters, and exception
374374
* handling flags.
375-
* <p/>
375+
* <p>
376376
* Statement separators and comments will be removed before executing individual statements within the supplied
377377
* script.
378-
* <p/>
378+
* <p>
379379
* <strong>Warning</strong>: this method does <em>not</em> release the provided {@link Connection}.
380380
*
381381
* @param connection the R2DBC connection to use to execute the script; already configured and ready to use.
@@ -398,10 +398,10 @@ public static Mono<Void> executeSqlScript(Connection connection, Resource resour
398398
/**
399399
* Execute the given SQL script using default settings for statement separators, comment delimiters, and exception
400400
* handling flags.
401-
* <p/>
401+
* <p>
402402
* Statement separators and comments will be removed before executing individual statements within the supplied
403403
* script.
404-
* <p/>
404+
* <p>
405405
* <strong>Warning</strong>: this method does <em>not</em> release the provided {@link Connection}.
406406
*
407407
* @param connection the R2DBC connection to use to execute the script; already configured and ready to use.
@@ -424,10 +424,10 @@ public static Mono<Void> executeSqlScript(Connection connection, EncodedResource
424424

425425
/**
426426
* Execute the given SQL script.
427-
* <p/>
427+
* <p>
428428
* Statement separators and comments will be removed before executing individual statements within the supplied
429429
* script.
430-
* <p/>
430+
* <p>
431431
* <strong>Warning</strong>: this method does <em>not</em> release the provided {@link Connection}.
432432
*
433433
* @param connection the R2DBC connection to use to execute the script; already configured and ready to use.

src/main/java/org/springframework/data/r2dbc/convert/R2dbcConverter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ public interface R2dbcConverter
7676
* Return whether the {@code type} is a simple type. Simple types are database primitives or types with a custom
7777
* mapping strategy.
7878
*
79-
* @param valueType the type to inspect, must not be {@literal null}.
79+
* @param type the type to inspect, must not be {@literal null}.
8080
* @return {@literal true} if the type is a simple one.
8181
* @see org.springframework.data.mapping.model.SimpleTypeHolder
8282
* @since 1.2

src/main/java/org/springframework/data/r2dbc/core/ConnectionAccessor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* Interface declaring methods that accept callback {@link Function} to operate within the scope of a
2828
* {@link Connection}. Callback functions operate on a provided connection and must not close the connection as the
2929
* connections may be pooled or be subject to other kinds of resource management.
30-
* <p/>
30+
* <p>
3131
* Callback functions are responsible for creating a {@link org.reactivestreams.Publisher} that defines the scope of how
3232
* long the allocated {@link Connection} is valid. Connections are released after the publisher terminates.
3333
*

src/main/java/org/springframework/data/r2dbc/core/R2dbcEntityTemplate.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ public void setApplicationContext(ApplicationContext applicationContext) throws
243243
* Set the {@link ReactiveEntityCallbacks} instance to use when invoking
244244
* {@link org.springframework.data.mapping.callback.ReactiveEntityCallbacks callbacks} like the
245245
* {@link BeforeSaveCallback}.
246-
* <p />
246+
* <p>
247247
* Overrides potentially existing {@link ReactiveEntityCallbacks}.
248248
*
249249
* @param entityCallbacks must not be {@literal null}.

src/main/java/org/springframework/data/r2dbc/dialect/BindMarkers.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* Bind markers represent placeholders in SQL queries for substitution for an actual parameter. Using bind markers
55
* allows creating safe queries so query strings are not required to contain escaped values but rather the driver
66
* encodes parameter in the appropriate representation.
7-
* <p/>
7+
* <p>
88
* {@link BindMarkers} is stateful and can be only used for a single binding pass of one or more parameters. It
99
* maintains bind indexes/bind parameter names.
1010
*

src/main/java/org/springframework/data/r2dbc/dialect/BindMarkersFactory.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
/**
88
* This class creates new {@link BindMarkers} instances to bind parameter for a specific {@link io.r2dbc.spi.Statement}.
9-
* <p/>
9+
* <p>
1010
* Bind markers can be typically represented as placeholder and identifier. Placeholders are used within the query to
1111
* execute so the underlying database system can substitute the placeholder with the actual value. Identifiers are used
1212
* in R2DBC drivers to bind a value to a bind marker. Identifiers are typically a part of an entire bind marker when
@@ -106,7 +106,7 @@ public boolean identifiablePlaceholders() {
106106
* Create named {@link BindMarkers} using identifiers to bind parameters. Named bind markers can support
107107
* {@link BindMarkers#next(String) name hints}. If no {@link BindMarkers#next(String) hint} is given, named bind
108108
* markers can use a counter or a random value source to generate unique bind markers.
109-
* <p/>
109+
* <p>
110110
* Allow customization of the bind marker placeholder {@code prefix} and {@code namePrefix} to represent the bind
111111
* marker as placeholder within the query.
112112
*

0 commit comments

Comments
 (0)