Skip to content

Commit 2f98a66

Browse files
christophstroblchristophstrobl
committed
Fix javadoc errors and warnings
Closes: #3835
1 parent 9e2f605 commit 2f98a66

File tree

76 files changed

+346
-360
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+346
-360
lines changed

Diff for: ‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/BindableMongoExpression.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
* expression. The expression will be wrapped within <code>{ ... }</code> if necessary. The actual parsing and parameter
3232
* binding of placeholders like {@code ?0} is delayed upon first call on the the target {@link Document} via
3333
* {@link #toDocument()}.
34-
* <p />
34+
* <br />
3535
*
3636
* <pre class="code">
3737
* $toUpper : $name -> { '$toUpper' : '$name' }

Diff for: ‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/MongoCollectionUtils.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020

2121
/**
2222
* Helper class featuring helper methods for working with MongoDb collections.
23-
* <p/>
24-
* <p/>
23+
* <br />
24+
* <br />
2525
* Mainly intended for internal use within the framework.
2626
*
2727
* @author Thomas Risberg

Diff for: ‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/MongoDatabaseUtils.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
* Helper class for managing a {@link MongoDatabase} instances via {@link MongoDatabaseFactory}. Used for obtaining
3131
* {@link ClientSession session bound} resources, such as {@link MongoDatabase} and
3232
* {@link com.mongodb.client.MongoCollection} suitable for transactional usage.
33-
* <p />
33+
* <br />
3434
* <strong>Note:</strong> Intended for internal usage only.
3535
*
3636
* @author Christoph Strobl
@@ -43,7 +43,7 @@ public class MongoDatabaseUtils {
4343
/**
4444
* Obtain the default {@link MongoDatabase database} form the given {@link MongoDatabaseFactory factory} using
4545
* {@link SessionSynchronization#ON_ACTUAL_TRANSACTION native session synchronization}.
46-
* <p />
46+
* <br />
4747
* Registers a {@link MongoSessionSynchronization MongoDB specific transaction synchronization} within the current
4848
* {@link Thread} if {@link TransactionSynchronizationManager#isSynchronizationActive() synchronization is active}.
4949
*
@@ -56,7 +56,7 @@ public static MongoDatabase getDatabase(MongoDatabaseFactory factory) {
5656

5757
/**
5858
* Obtain the default {@link MongoDatabase database} form the given {@link MongoDatabaseFactory factory}.
59-
* <p />
59+
* <br />
6060
* Registers a {@link MongoSessionSynchronization MongoDB specific transaction synchronization} within the current
6161
* {@link Thread} if {@link TransactionSynchronizationManager#isSynchronizationActive() synchronization is active}.
6262
*
@@ -71,7 +71,7 @@ public static MongoDatabase getDatabase(MongoDatabaseFactory factory, SessionSyn
7171
/**
7272
* Obtain the {@link MongoDatabase database} with given name form the given {@link MongoDatabaseFactory factory} using
7373
* {@link SessionSynchronization#ON_ACTUAL_TRANSACTION native session synchronization}.
74-
* <p />
74+
* <br />
7575
* Registers a {@link MongoSessionSynchronization MongoDB specific transaction synchronization} within the current
7676
* {@link Thread} if {@link TransactionSynchronizationManager#isSynchronizationActive() synchronization is active}.
7777
*
@@ -85,7 +85,7 @@ public static MongoDatabase getDatabase(@Nullable String dbName, MongoDatabaseFa
8585

8686
/**
8787
* Obtain the {@link MongoDatabase database} with given name form the given {@link MongoDatabaseFactory factory}.
88-
* <p />
88+
* <br />
8989
* Registers a {@link MongoSessionSynchronization MongoDB specific transaction synchronization} within the current
9090
* {@link Thread} if {@link TransactionSynchronizationManager#isSynchronizationActive() synchronization is active}.
9191
*

Diff for: ‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/MongoExpression.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
/**
1919
* Wrapper object for MongoDB expressions like {@code $toUpper : $name} that manifest as {@link org.bson.Document} when
2020
* passed on to the driver.
21-
* <p />
21+
* <br />
2222
* A set of predefined {@link MongoExpression expressions}, including a
2323
* {@link org.springframework.data.mongodb.core.aggregation.AggregationSpELExpression SpEL based variant} for method
2424
* like expressions (eg. {@code toUpper(name)}) are available via the

Diff for: ‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/MongoResourceHolder.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
/**
2525
* MongoDB specific {@link ResourceHolderSupport resource holder}, wrapping a {@link ClientSession}.
2626
* {@link MongoTransactionManager} binds instances of this class to the thread.
27-
* <p />
27+
* <br />
2828
* <strong>Note:</strong> Intended for internal usage only.
2929
*
3030
* @author Christoph Strobl

Diff for: ‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/MongoTransactionManager.java

+8-8
Original file line numberDiff line numberDiff line change
@@ -37,18 +37,18 @@
3737
/**
3838
* A {@link org.springframework.transaction.PlatformTransactionManager} implementation that manages
3939
* {@link ClientSession} based transactions for a single {@link MongoDatabaseFactory}.
40-
* <p />
40+
* <br />
4141
* Binds a {@link ClientSession} from the specified {@link MongoDatabaseFactory} to the thread.
42-
* <p />
42+
* <br />
4343
* {@link TransactionDefinition#isReadOnly() Readonly} transactions operate on a {@link ClientSession} and enable causal
4444
* consistency, and also {@link ClientSession#startTransaction() start}, {@link ClientSession#commitTransaction()
4545
* commit} or {@link ClientSession#abortTransaction() abort} a transaction.
46-
* <p />
46+
* <br />
4747
* Application code is required to retrieve the {@link com.mongodb.client.MongoDatabase} via
4848
* {@link MongoDatabaseUtils#getDatabase(MongoDatabaseFactory)} instead of a standard
4949
* {@link MongoDatabaseFactory#getMongoDatabase()} call. Spring classes such as
5050
* {@link org.springframework.data.mongodb.core.MongoTemplate} use this strategy implicitly.
51-
* <p />
51+
* <br />
5252
* By default failure of a {@literal commit} operation raises a {@link TransactionSystemException}. One may override
5353
* {@link #doCommit(MongoTransactionObject)} to implement the
5454
* <a href="https://docs.mongodb.com/manual/core/transactions/#retry-commit-operation">Retry Commit Operation</a>
@@ -69,11 +69,11 @@ public class MongoTransactionManager extends AbstractPlatformTransactionManager
6969

7070
/**
7171
* Create a new {@link MongoTransactionManager} for bean-style usage.
72-
* <p />
72+
* <br />
7373
* <strong>Note:</strong>The {@link MongoDatabaseFactory db factory} has to be
7474
* {@link #setDbFactory(MongoDatabaseFactory) set} before using the instance. Use this constructor to prepare a
7575
* {@link MongoTransactionManager} via a {@link org.springframework.beans.factory.BeanFactory}.
76-
* <p />
76+
* <br />
7777
* Optionally it is possible to set default {@link TransactionOptions transaction options} defining
7878
* {@link com.mongodb.ReadConcern} and {@link com.mongodb.WriteConcern}.
7979
*
@@ -212,8 +212,8 @@ protected final void doCommit(DefaultTransactionStatus status) throws Transactio
212212
* By default those labels are ignored, nevertheless one might check for
213213
* {@link MongoException#UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL transient commit errors labels} and retry the the
214214
* commit. <br />
215+
* <pre>
215216
* <code>
216-
* <pre>
217217
* int retries = 3;
218218
* do {
219219
* try {
@@ -226,8 +226,8 @@ protected final void doCommit(DefaultTransactionStatus status) throws Transactio
226226
* }
227227
* Thread.sleep(500);
228228
* } while (--retries > 0);
229-
* </pre>
230229
* </code>
230+
* </pre>
231231
*
232232
* @param transactionObject never {@literal null}.
233233
* @throws Exception in case of transaction errors.

Diff for: ‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/ReactiveMongoDatabaseUtils.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
* Helper class for managing reactive {@link MongoDatabase} instances via {@link ReactiveMongoDatabaseFactory}. Used for
3737
* obtaining {@link ClientSession session bound} resources, such as {@link MongoDatabase} and {@link MongoCollection}
3838
* suitable for transactional usage.
39-
* <p />
39+
* <br />
4040
* <strong>Note:</strong> Intended for internal usage only.
4141
*
4242
* @author Mark Paluch
@@ -75,7 +75,7 @@ public static Mono<Boolean> isTransactionActive(ReactiveMongoDatabaseFactory dat
7575
/**
7676
* Obtain the default {@link MongoDatabase database} form the given {@link ReactiveMongoDatabaseFactory factory} using
7777
* {@link SessionSynchronization#ON_ACTUAL_TRANSACTION native session synchronization}.
78-
* <p />
78+
* <br />
7979
* Registers a {@link MongoSessionSynchronization MongoDB specific transaction synchronization} within the subscriber
8080
* {@link Context} if {@link TransactionSynchronizationManager#isSynchronizationActive() synchronization is active}.
8181
*
@@ -88,7 +88,7 @@ public static Mono<MongoDatabase> getDatabase(ReactiveMongoDatabaseFactory facto
8888

8989
/**
9090
* Obtain the default {@link MongoDatabase database} form the given {@link ReactiveMongoDatabaseFactory factory}.
91-
* <p />
91+
* <br />
9292
* Registers a {@link MongoSessionSynchronization MongoDB specific transaction synchronization} within the subscriber
9393
* {@link Context} if {@link TransactionSynchronizationManager#isSynchronizationActive() synchronization is active}.
9494
*
@@ -104,7 +104,7 @@ public static Mono<MongoDatabase> getDatabase(ReactiveMongoDatabaseFactory facto
104104
/**
105105
* Obtain the {@link MongoDatabase database} with given name form the given {@link ReactiveMongoDatabaseFactory
106106
* factory} using {@link SessionSynchronization#ON_ACTUAL_TRANSACTION native session synchronization}.
107-
* <p />
107+
* <br />
108108
* Registers a {@link MongoSessionSynchronization MongoDB specific transaction synchronization} within the subscriber
109109
* {@link Context} if {@link TransactionSynchronizationManager#isSynchronizationActive() synchronization is active}.
110110
*
@@ -119,7 +119,7 @@ public static Mono<MongoDatabase> getDatabase(String dbName, ReactiveMongoDataba
119119
/**
120120
* Obtain the {@link MongoDatabase database} with given name form the given {@link ReactiveMongoDatabaseFactory
121121
* factory}.
122-
* <p />
122+
* <br />
123123
* Registers a {@link MongoSessionSynchronization MongoDB specific transaction synchronization} within the subscriber
124124
* {@link Context} if {@link TransactionSynchronizationManager#isSynchronizationActive() synchronization is active}.
125125
*

Diff for: ‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/ReactiveMongoResourceHolder.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
/**
2525
* MongoDB specific resource holder, wrapping a {@link ClientSession}. {@link ReactiveMongoTransactionManager} binds
2626
* instances of this class to the subscriber context.
27-
* <p />
27+
* <br />
2828
* <strong>Note:</strong> Intended for internal usage only.
2929
*
3030
* @author Mark Paluch

Diff for: ‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/ReactiveMongoTransactionManager.java

+6-6
Original file line numberDiff line numberDiff line change
@@ -38,21 +38,21 @@
3838
* A {@link org.springframework.transaction.ReactiveTransactionManager} implementation that manages
3939
* {@link com.mongodb.reactivestreams.client.ClientSession} based transactions for a single
4040
* {@link org.springframework.data.mongodb.ReactiveMongoDatabaseFactory}.
41-
* <p />
41+
* <br />
4242
* Binds a {@link ClientSession} from the specified
4343
* {@link org.springframework.data.mongodb.ReactiveMongoDatabaseFactory} to the subscriber
4444
* {@link reactor.util.context.Context}.
45-
* <p />
45+
* <br />
4646
* {@link org.springframework.transaction.TransactionDefinition#isReadOnly() Readonly} transactions operate on a
4747
* {@link ClientSession} and enable causal consistency, and also {@link ClientSession#startTransaction() start},
4848
* {@link com.mongodb.reactivestreams.client.ClientSession#commitTransaction() commit} or
4949
* {@link ClientSession#abortTransaction() abort} a transaction.
50-
* <p />
50+
* <br />
5151
* Application code is required to retrieve the {@link com.mongodb.reactivestreams.client.MongoDatabase} via
5252
* {@link org.springframework.data.mongodb.ReactiveMongoDatabaseUtils#getDatabase(ReactiveMongoDatabaseFactory)} instead
5353
* of a standard {@link org.springframework.data.mongodb.ReactiveMongoDatabaseFactory#getMongoDatabase()} call. Spring
5454
* classes such as {@link org.springframework.data.mongodb.core.ReactiveMongoTemplate} use this strategy implicitly.
55-
* <p />
55+
* <br />
5656
* By default failure of a {@literal commit} operation raises a {@link TransactionSystemException}. You can override
5757
* {@link #doCommit(TransactionSynchronizationManager, ReactiveMongoTransactionObject)} to implement the
5858
* <a href="https://docs.mongodb.com/manual/core/transactions/#retry-commit-operation">Retry Commit Operation</a>
@@ -71,11 +71,11 @@ public class ReactiveMongoTransactionManager extends AbstractReactiveTransaction
7171

7272
/**
7373
* Create a new {@link ReactiveMongoTransactionManager} for bean-style usage.
74-
* <p />
74+
* <br />
7575
* <strong>Note:</strong>The {@link org.springframework.data.mongodb.ReactiveMongoDatabaseFactory db factory} has to
7676
* be {@link #setDatabaseFactory(ReactiveMongoDatabaseFactory)} set} before using the instance. Use this constructor
7777
* to prepare a {@link ReactiveMongoTransactionManager} via a {@link org.springframework.beans.factory.BeanFactory}.
78-
* <p />
78+
* <br />
7979
* Optionally it is possible to set default {@link TransactionOptions transaction options} defining
8080
* {@link com.mongodb.ReadConcern} and {@link com.mongodb.WriteConcern}.
8181
*

Diff for: ‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/SessionAwareMethodInterceptor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
/**
3636
* {@link MethodInterceptor} implementation looking up and invoking an alternative target method having
3737
* {@link ClientSession} as its first argument. This allows seamless integration with the existing code base.
38-
* <p />
38+
* <br />
3939
* The {@link MethodInterceptor} is aware of methods on {@code MongoCollection} that my return new instances of itself
4040
* like (eg. {@link com.mongodb.reactivestreams.client.MongoCollection#withWriteConcern(WriteConcern)} and decorate them
4141
* if not already proxied.

Diff for: ‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/SpringDataMongoDB.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ public static MongoDriverInformation driverInformation() {
4848

4949
/**
5050
* Fetches the "Implementation-Version" manifest attribute from the jar file.
51-
* <p />
51+
* <br />
5252
* Note that some ClassLoaders do not expose the package metadata, hence this class might not be able to determine the
5353
* version in all environments. In this case the current Major version is returned as a fallback.
5454
*

Diff for: ‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/MongoConfigurationSupport.java

+1-2
Original file line numberDiff line numberDiff line change
@@ -172,8 +172,7 @@ protected Set<Class<?>> scanForEntities(String basePackage) throws ClassNotFound
172172

173173
/**
174174
* Configures whether to abbreviate field names for domain objects by configuring a
175-
* {@link CamelCaseAbbreviatingFieldNamingStrategy} on the {@link MongoMappingContext} instance created. For advanced
176-
* customization needs, consider overriding {@link #mappingMongoConverter()}.
175+
* {@link CamelCaseAbbreviatingFieldNamingStrategy} on the {@link MongoMappingContext} instance created.
177176
*
178177
* @return
179178
*/

Diff for: ‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ChangeStreamOptions.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -242,13 +242,13 @@ public ChangeStreamOptionsBuilder collation(Collation collation) {
242242

243243
/**
244244
* Set the filter to apply.
245-
* <p/>
245+
* <br />
246246
* Fields on aggregation expression root level are prefixed to map to fields contained in
247247
* {@link ChangeStreamDocument#getFullDocument() fullDocument}. However {@literal operationType}, {@literal ns},
248248
* {@literal documentKey} and {@literal fullDocument} are reserved words that will be omitted, and therefore taken
249249
* as given, during the mapping procedure. You may want to have a look at the
250250
* <a href="https://docs.mongodb.com/manual/reference/change-events/">structure of Change Events</a>.
251-
* <p/>
251+
* <br />
252252
* Use {@link org.springframework.data.mongodb.core.aggregation.TypedAggregation} to ensure filter expressions are
253253
* mapped to domain type fields.
254254
*

Diff for: ‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/CollectionOptions.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,7 @@ public Optional<ValidationLevel> getValidationLevel() {
428428
/**
429429
* Get the {@code validationAction} to perform.
430430
*
431-
* @return @return {@link Optional#empty()} if not set.
431+
* @return {@link Optional#empty()} if not set.
432432
*/
433433
public Optional<ValidationAction> getValidationAction() {
434434
return Optional.ofNullable(validationAction);

Diff for: ‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ExecutableFindOperation.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ default Optional<T> first() {
125125

126126
/**
127127
* Get the number of matching elements.
128-
* <p />
128+
* <br />
129129
* This method uses an {@link com.mongodb.client.MongoCollection#countDocuments(org.bson.conversions.Bson, com.mongodb.client.model.CountOptions) aggregation
130130
* execution} even for empty {@link Query queries} which may have an impact on performance, but guarantees shard,
131131
* session and transaction compliance. In case an inaccurate count satisfies the applications needs use

Diff for: ‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ExecutableUpdateOperation.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ default Optional<T> findAndModify() {
8989

9090
/**
9191
* Trigger
92-
* <a href="https://docs.mongodb.com/manual/reference/method/db.collection.findOneAndReplace/">findOneAndReplace<a/>
92+
* <a href="https://docs.mongodb.com/manual/reference/method/db.collection.findOneAndReplace/">findOneAndReplace</a>
9393
* execution by calling one of the terminating methods.
9494
*
9595
* @author Mark Paluch

Diff for: ‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/FindAndReplaceOptions.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
/**
1919
* Options for
20-
* <a href="https://docs.mongodb.com/manual/reference/method/db.collection.findOneAndReplace/">findOneAndReplace<a/>.
20+
* <a href="https://docs.mongodb.com/manual/reference/method/db.collection.findOneAndReplace/">findOneAndReplace</a>.
2121
* <br />
2222
* Defaults to
2323
* <dl>

Diff for: ‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoDatabaseFactorySupport.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
/**
3434
* Common base class for usage with both {@link com.mongodb.client.MongoClients} defining common properties such as
3535
* database name and exception translator.
36-
* <p/>
36+
* <br />
3737
* Not intended to be used directly.
3838
*
3939
* @author Christoph Strobl

Diff for: ‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoDbFactorySupport.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
/**
2121
* Common base class for usage with both {@link com.mongodb.client.MongoClients} defining common properties such as
2222
* database name and exception translator.
23-
* <p/>
23+
* <br />
2424
* Not intended to be used directly.
2525
*
2626
* @author Christoph Strobl

Diff for: ‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoJsonSchemaCreator.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
* following mapping rules.
4141
* <p>
4242
* <strong>Required Properties</strong>
43+
* </p>
4344
* <ul>
4445
* <li>Properties of primitive type</li>
4546
* </ul>
@@ -61,7 +62,7 @@
6162
* {@link org.springframework.data.annotation.Id _id} properties using types that can be converted into
6263
* {@link org.bson.types.ObjectId} like {@link String} will be mapped to {@code type : 'object'} unless there is more
6364
* specific information available via the {@link org.springframework.data.mongodb.core.mapping.MongoId} annotation.
64-
* </p>
65+
6566
* {@link Encrypted} properties will contain {@literal encrypt} information.
6667
*
6768
* @author Christoph Strobl

0 commit comments

Comments
 (0)