Skip to content

Commit 45a10d6

Browse files
committed
Fix invalid Javadoc references.
See #2175
1 parent 24b2a39 commit 45a10d6

File tree

87 files changed

+164
-212
lines changed

Some content is hidden

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

87 files changed

+164
-212
lines changed

Diff for: src/main/java/org/springframework/data/redis/cache/BatchStrategies.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ private BatchStrategies() {
4444
* A {@link BatchStrategy} using a single {@code KEYS} and {@code DEL} command to remove all matching keys.
4545
* {@code KEYS} scans the entire keyspace of the Redis database and can block the Redis worker thread for a long time
4646
* on large keyspaces.
47-
* <p/>
47+
* <p>
4848
* {@code KEYS} is supported for standalone and clustered (sharded) Redis operation modes.
4949
*
5050
* @return batching strategy using {@code KEYS}.
@@ -56,7 +56,7 @@ public static BatchStrategy keys() {
5656
/**
5757
* A {@link BatchStrategy} using a {@code SCAN} cursors and potentially multiple {@code DEL} commands to remove all
5858
* matching keys. This strategy allows a configurable batch size to optimize for scan batching.
59-
* <p/>
59+
* <p>
6060
* Note that using the {@code SCAN} strategy might be not supported on all drivers and Redis operation modes.
6161
*
6262
* @return batching strategy using {@code SCAN}.

Diff for: src/main/java/org/springframework/data/redis/cache/BatchStrategy.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919

2020
/**
2121
* A {@link BatchStrategy} to be used with {@link RedisCacheWriter}.
22-
* <p/>
22+
* <p>
2323
* Mainly used to clear the cache.
24-
* <p/>
24+
* <p>
2525
* Predefined strategies using the {@link BatchStrategies#keys() KEYS} or {@link BatchStrategies#scan(int) SCAN}
2626
* commands can be found in {@link BatchStrategies}.
2727
*

Diff for: src/main/java/org/springframework/data/redis/cache/RedisCache.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939

4040
/**
4141
* {@link org.springframework.cache.Cache} implementation using for Redis as underlying store.
42-
* <p/>
42+
* <p>
4343
* Use {@link RedisCacheManager} to create {@link RedisCache} instances.
4444
*
4545
* @author Christoph Strobl

Diff for: src/main/java/org/springframework/data/redis/cache/RedisCacheConfiguration.java

+1
Original file line numberDiff line numberDiff line change
@@ -362,6 +362,7 @@ public void configureKeyConverters(Consumer<ConverterRegistry> registryConsumer)
362362
* <ul>
363363
* <li>{@link String} to {@link byte byte[]} using UTF-8 encoding.</li>
364364
* <li>{@link SimpleKey} to {@link String}</li>
365+
* </ul>
365366
*
366367
* @param registry must not be {@literal null}.
367368
*/

Diff for: src/main/java/org/springframework/data/redis/cache/RedisCacheManager.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@
3232

3333
/**
3434
* {@link org.springframework.cache.CacheManager} backed by a {@link RedisCache Redis} cache.
35-
* <p />
35+
* <p>
3636
* This cache manager creates caches by default upon first write. Empty caches are not visible on Redis due to how Redis
3737
* represents empty data structures.
38-
* <p />
38+
* <p>
3939
* Caches requiring a different {@link RedisCacheConfiguration} than the default configuration can be specified via
4040
* {@link RedisCacheManagerBuilder#withInitialCacheConfigurations(Map)}.
4141
*
@@ -170,7 +170,7 @@ public RedisCacheManager(RedisCacheWriter cacheWriter, RedisCacheConfiguration d
170170
* <dt>locking</dt>
171171
* <dd>disabled</dd>
172172
* <dt>batch strategy</dt>
173-
* <dd>{@link BatchStrategy#keys() KEYS}</dd>
173+
* <dd>{@link BatchStrategies#keys()}</dd>
174174
* <dt>cache configuration</dt>
175175
* <dd>{@link RedisCacheConfiguration#defaultCacheConfig()}</dd>
176176
* <dt>initial caches</dt>
@@ -423,7 +423,7 @@ public RedisCacheManagerBuilder withCacheConfiguration(String cacheName,
423423

424424
/**
425425
* Disable in-flight {@link org.springframework.cache.Cache} creation for unconfigured caches.
426-
* <p />
426+
* <p>
427427
* {@link RedisCacheManager#getMissingCache(String)} returns {@literal null} for any unconfigured
428428
* {@link org.springframework.cache.Cache} instead of a new {@link RedisCache} instance. This allows eg.
429429
* {@link org.springframework.cache.support.CompositeCacheManager} to chime in.

Diff for: src/main/java/org/springframework/data/redis/connection/BitFieldSubCommands.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ protected BitFieldSubCommands set(BitFieldSet set) {
113113
}
114114

115115
/**
116-
* Obtain a new {@link BitFieldIncrByBuilder} for creating and adding a {@link BitFieldIncrby} sub command.
116+
* Obtain a new {@link BitFieldIncrByBuilder} for creating and adding a {@link BitFieldIncrBy} sub command.
117117
*
118118
* @param type must not be {@literal null}.
119119
* @return
@@ -125,7 +125,7 @@ public BitFieldIncrByBuilder incr(BitFieldType type) {
125125
/**
126126
* Create new {@link BitFieldSubCommands} adding given {@link BitFieldIncrBy} to the sub commands.
127127
*
128-
* @param get must not be {@literal null}.
128+
* @param incrBy must not be {@literal null}.
129129
* @return
130130
*/
131131
protected BitFieldSubCommands incr(BitFieldIncrBy incrBy) {

Diff for: src/main/java/org/springframework/data/redis/connection/ReactiveClusterServerCommands.java

+1-2
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public interface ReactiveClusterServerCommands extends ReactiveServerCommands {
5656
* Get time unix timestamp of last successful {@link #bgSave()} operation in seconds.
5757
*
5858
* @param node must not be {@literal null}.
59-
* @return @return {@link Mono} wrapping unix timestamp.
59+
* @return {@link Mono} wrapping unix timestamp.
6060
* @throws IllegalArgumentException when {@code node} is {@literal null}.
6161
* @see RedisServerCommands#lastSave()
6262
*/
@@ -108,7 +108,6 @@ public interface ReactiveClusterServerCommands extends ReactiveServerCommands {
108108
* <li>cpu utilization</li>
109109
* <li>replication</li>
110110
* </ul>
111-
* <p>
112111
*
113112
* @param node must not be {@literal null}.
114113
* @return {@link Mono} wrapping server information.

Diff for: src/main/java/org/springframework/data/redis/connection/ReactiveGeoCommands.java

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

1818
import static org.springframework.data.redis.connection.RedisGeoCommands.*;
1919

20-
import org.springframework.data.redis.domain.geo.GeoReference;
21-
import org.springframework.data.redis.domain.geo.GeoShape;
2220
import reactor.core.publisher.Flux;
2321
import reactor.core.publisher.Mono;
2422

@@ -43,6 +41,8 @@
4341
import org.springframework.data.redis.connection.ReactiveRedisConnection.MultiValueResponse;
4442
import org.springframework.data.redis.connection.ReactiveRedisConnection.NumericResponse;
4543
import org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs.Flag;
44+
import org.springframework.data.redis.domain.geo.GeoReference;
45+
import org.springframework.data.redis.domain.geo.GeoShape;
4646
import org.springframework.lang.Nullable;
4747
import org.springframework.util.Assert;
4848

@@ -1279,7 +1279,7 @@ public static GeoSearchCommand within(GeoShape shape) {
12791279
/**
12801280
* Sets the geoset {@literal key}. Constructs a new command instance with all previously configured properties.
12811281
*
1282-
* @param member must not be {@literal null}.
1282+
* @param reference must not be {@literal null}.
12831283
* @return a new {@link GeoSearchCommand} with {@literal key} applied.
12841284
*/
12851285
public GeoSearchCommand at(GeoReference<ByteBuffer> reference) {
@@ -1292,7 +1292,7 @@ public GeoSearchCommand at(GeoReference<ByteBuffer> reference) {
12921292
/**
12931293
* Sets the geoset {@literal key}. Constructs a new command instance with all previously configured properties.
12941294
*
1295-
* @param member must not be {@literal null}.
1295+
* @param key must not be {@literal null}.
12961296
* @return a new {@link GeoSearchCommand} with {@literal key} applied.
12971297
*/
12981298
public GeoSearchCommand in(ByteBuffer key) {
@@ -1370,7 +1370,7 @@ public static GeoSearchStoreCommand within(GeoShape shape) {
13701370
/**
13711371
* Sets the geoset {@literal key}. Constructs a new command instance with all previously configured properties.
13721372
*
1373-
* @param member must not be {@literal null}.
1373+
* @param reference must not be {@literal null}.
13741374
* @return a new {@link GeoSearchStoreCommand} with {@literal key} applied.
13751375
*/
13761376
public GeoSearchStoreCommand at(GeoReference<ByteBuffer> reference) {
@@ -1383,7 +1383,7 @@ public GeoSearchStoreCommand at(GeoReference<ByteBuffer> reference) {
13831383
/**
13841384
* Sets the geoset {@literal key}. Constructs a new command instance with all previously configured properties.
13851385
*
1386-
* @param member must not be {@literal null}.
1386+
* @param key must not be {@literal null}.
13871387
* @return a new {@link GeoSearchStoreCommand} with {@literal key} applied.
13881388
*/
13891389
public GeoSearchStoreCommand in(ByteBuffer key) {
@@ -1396,7 +1396,7 @@ public GeoSearchStoreCommand in(ByteBuffer key) {
13961396
/**
13971397
* Sets the geoset {@literal destKey}. Constructs a new command instance with all previously configured properties.
13981398
*
1399-
* @param member must not be {@literal null}.
1399+
* @param destKey must not be {@literal null}.
14001400
* @return a new {@link GeoSearchStoreCommand} with {@literal destKey} applied.
14011401
*/
14021402
public GeoSearchStoreCommand storeAt(ByteBuffer destKey) {

Diff for: src/main/java/org/springframework/data/redis/connection/ReactiveKeyCommands.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ public CopyCommand to(ByteBuffer targetKey) {
9393
/**
9494
* Applies {@code replace}. Constructs a new command instance with all previously configured properties.
9595
*
96-
* @param key must not be {@literal null}.
96+
* @param replace
9797
* @return a new {@link CopyCommand} with {@literal replace} applied.
9898
*/
9999
public CopyCommand replace(boolean replace) {

Diff for: src/main/java/org/springframework/data/redis/connection/ReactiveListCommands.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -830,7 +830,7 @@ default Mono<ByteBuffer> bLMove(ByteBuffer sourceKey, ByteBuffer destinationKey,
830830
* Atomically returns and removes the first/last element (head/tail depending on the {@code from} argument) of the
831831
* list stored at {@code sourceKey}, and pushes the element at the first/last element (head/tail depending on the
832832
* {@code to} argument) of the list stored at {@code destinationKey}.
833-
* <p/>
833+
* <p>
834834
* <b>Blocks connection</b> until element available or {@code timeout} reached.
835835
*
836836
* @param commands must not be {@literal null}.

Diff for: src/main/java/org/springframework/data/redis/connection/ReactivePubSubCommands.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public interface ReactivePubSubCommands {
3434

3535
/**
3636
* Creates a subscription for this connection. Connections can have multiple {@link ReactiveSubscription}s.
37-
* <p/>
37+
* <p>
3838
* Use {@link #createSubscription(SubscriptionListener)} to get notified when the subscription completes.
3939
*
4040
* @return the subscription.
@@ -77,7 +77,7 @@ default Mono<Long> publish(ByteBuffer channel, ByteBuffer message) {
7777
* Subscribes the connection to the given {@code channels}. Once subscribed, a connection enters listening mode and
7878
* can only subscribe to other channels or unsubscribe. No other commands are accepted until the connection is
7979
* unsubscribed.
80-
* <p />
80+
* <p>
8181
* Note that cancellation of the {@link Flux} will unsubscribe from {@code channels}.
8282
*
8383
* @param channels channel names, must not be {@literal null}.
@@ -89,7 +89,7 @@ default Mono<Long> publish(ByteBuffer channel, ByteBuffer message) {
8989
* Subscribes the connection to all channels matching the given {@code patterns}. Once subscribed, a connection enters
9090
* listening mode and can only subscribe to other channels or unsubscribe. No other commands are accepted until the
9191
* connection is unsubscribed.
92-
* <p />
92+
* <p>
9393
* Note that cancellation of the {@link Flux} will unsubscribe from {@code patterns}.
9494
*
9595
* @param patterns channel name patterns, must not be {@literal null}.

Diff for: src/main/java/org/springframework/data/redis/connection/ReactiveServerCommands.java

-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,6 @@ public interface ReactiveServerCommands {
9696
* <li>cpu utilization</li>
9797
* <li>replication</li>
9898
* </ul>
99-
* <p>
10099
*
101100
* @return {@link Mono} wrapping server information.
102101
* @see <a href="https://redis.io/commands/info">Redis Documentation: INFO</a>

Diff for: src/main/java/org/springframework/data/redis/connection/ReactiveSetCommands.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,7 @@ private SMIsMemberCommand(@Nullable ByteBuffer key, List<ByteBuffer> values) {
576576
/**
577577
* Creates a new {@link SMIsMemberCommand} given one or more {@literal values}.
578578
*
579-
* @param value must not be {@literal null}.
579+
* @param values must not be {@literal null}.
580580
* @return a new {@link SMIsMemberCommand} for a {@literal value}.
581581
*/
582582
public static SMIsMemberCommand values(List<ByteBuffer> values) {

Diff for: src/main/java/org/springframework/data/redis/connection/ReactiveStringCommands.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ public static GetExCommand key(ByteBuffer key) {
276276
/**
277277
* Applies {@link Expiration}. Constructs a new command instance with all previously configured properties.
278278
*
279-
* @param options must not be {@literal null}.
279+
* @param expiration must not be {@literal null}.
280280
* @return a new {@link GetExCommand} with {@link Expiration} applied.
281281
*/
282282
public GetExCommand withExpiration(Expiration expiration) {

Diff for: src/main/java/org/springframework/data/redis/connection/ReactiveSubscription.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
* {@link #subscribe(ByteBuffer...) channels} and {@link #pSubscribe(ByteBuffer...) patterns}. It provides access to the
3030
* {@link ChannelMessage} {@link #receive() stream} that emits only messages for channels and patterns registered in
3131
* this {@link ReactiveSubscription}.
32-
* <p />
32+
* <p>
3333
* A reactive Redis connection can have multiple subscriptions. If two or more subscriptions subscribe to the same
3434
* target (channel/pattern) and one unsubscribes, then the other one will no longer receive messages for the target due
3535
* to how Redis handled Pub/Sub subscription.
@@ -103,7 +103,7 @@ public interface ReactiveSubscription {
103103
/**
104104
* Retrieve the message stream emitting {@link Message messages}. The resulting message stream contains only messages
105105
* for subscribed and registered {@link #getChannels() channels} and {@link #getPatterns() patterns}.
106-
* <p />
106+
* <p>
107107
* Stream publishing uses {@link reactor.core.publisher.ConnectableFlux} turning the stream into a hot sequence.
108108
* Emission is paused if there is no demand. Messages received in that time are buffered. This stream terminates
109109
* either if all subscribers unsubscribe or if this {@link Subscription} is {@link #cancel() is terminated}.

Diff for: src/main/java/org/springframework/data/redis/connection/ReactiveZSetCommands.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -1540,7 +1540,7 @@ public BZPopCommand blockingFor(Duration timeout) {
15401540
* Applies a {@link Duration timeout}. Constructs a new command instance with all previously configured properties.
15411541
*
15421542
* @param timeout value.
1543-
* @param timeout must not be {@literal null}.
1543+
* @param timeUnit must not be {@literal null}.
15441544
* @return a new {@link BZPopCommand} with {@link Duration timeout} applied.
15451545
*/
15461546
public BZPopCommand blockingFor(long timeout, TimeUnit timeUnit) {

Diff for: src/main/java/org/springframework/data/redis/connection/RedisClusterConfiguration.java

+1-2
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,7 @@ public RedisClusterConfiguration() {
6767
* clusterHostAndPorts[0] = 127.0.0.1:23679
6868
* clusterHostAndPorts[1] = 127.0.0.1:23680 ...
6969
* </code>
70-
*
71-
* <pre>
70+
* </pre>
7271
*
7372
* @param clusterNodes must not be {@literal null}.
7473
*/

Diff for: src/main/java/org/springframework/data/redis/connection/RedisListCommands.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ default Long lPos(byte[] key, byte[] element) {
218218
* Atomically returns and removes the first/last element (head/tail depending on the {@code from} argument) of the
219219
* list stored at {@code sourceKey}, and pushes the element at the first/last element (head/tail depending on the
220220
* {@code to} argument) of the list stored at {@code destinationKey}.
221-
* <p/>
221+
* <p>
222222
* <b>Blocks connection</b> until element available or {@code timeout} reached.
223223
*
224224
* @param sourceKey must not be {@literal null}.

Diff for: src/main/java/org/springframework/data/redis/connection/RedisPassword.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@
2727

2828
/**
2929
* Value object which may or may not contain a Redis password.
30-
* <p/>
30+
* <p>
3131
* If a password is present, {@code isPresent()} will return {@code true} and {@code get()} will return the value.
32-
* <p/>
32+
* <p>
3333
* The password is stored as character array.
3434
*
3535
* @author Mark Paluch
@@ -109,7 +109,7 @@ public char[] get() throws NoSuchElementException {
109109

110110
/**
111111
* Map the password using a {@link Function} and return a {@link Optional} containing the mapped value.
112-
* <p/>
112+
* <p>
113113
* Absent passwords return a {@link Optional#empty()}.
114114
*
115115
* @param mapper must not be {@literal null}.
@@ -124,7 +124,7 @@ public <R> Optional<R> map(Function<char[], R> mapper) {
124124

125125
/**
126126
* Adopt the password to {@link Optional} containing the password value.
127-
* <p/>
127+
* <p>
128128
* Absent passwords return a {@link Optional#empty()}.
129129
*
130130
* @return the {@link Optional} containing the password value.

Diff for: src/main/java/org/springframework/data/redis/connection/RedisSentinelConfiguration.java

+1-2
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,7 @@ public RedisSentinelConfiguration() {
6767
*
6868
* <pre>
6969
* sentinelHostAndPorts[0] = 127.0.0.1:23679 sentinelHostAndPorts[1] = 127.0.0.1:23680 ...
70-
*
71-
* <pre>
70+
* </pre>
7271
*
7372
* @param sentinelHostAndPorts must not be {@literal null}.
7473
* @since 1.5

Diff for: src/main/java/org/springframework/data/redis/connection/RedisServerCommands.java

-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,6 @@ default void bgWriteAof() {
115115
* <li>cpu utilization</li>
116116
* <li>replication</li>
117117
* </ul>
118-
* <p>
119118
*
120119
* @return {@literal null} when used in pipeline / transaction.
121120
* @see <a href="https://redis.io/commands/info">Redis Documentation: INFO</a>

Diff for: src/main/java/org/springframework/data/redis/connection/RedisStreamCommands.java

+4-6
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,8 @@ default RecordId xAdd(byte[] key, Map<byte[], byte[]> content) {
8787
}
8888

8989
/**
90-
* Append the given {@link MapRecord record} to the stream stored at {@link Record#getStream()}. <br />
91-
* If you prefer manual id assignment over server generated ones make sure to provide an id via
92-
* {@link Record#withId(RecordId)}.
90+
* Append the given {@link MapRecord record} to the stream stored at {@code Record#getStream}. If you prefer manual id
91+
* assignment over server generated ones make sure to provide an id via {@code Record#withId}.
9392
*
9493
* @param record the {@link MapRecord record} to append.
9594
* @return the {@link RecordId id} after save. {@literal null} when used in pipeline / transaction.
@@ -100,9 +99,8 @@ default RecordId xAdd(MapRecord<byte[], byte[], byte[]> record) {
10099
}
101100

102101
/**
103-
* Append the given {@link MapRecord record} to the stream stored at {@link Record#getStream()}. <br />
104-
* If you prefer manual id assignment over server generated ones make sure to provide an id via
105-
* {@link Record#withId(RecordId)}.
102+
* Append the given {@link MapRecord record} to the stream stored at {@code Record#getStream}. If you prefer manual id
103+
* assignment over server generated ones make sure to provide an id via {@code Record#withId}.
106104
*
107105
* @param record the {@link MapRecord record} to append.
108106
* @param options additional options (eg. {@literal MAXLEN}). Must not be {@literal null}, use

0 commit comments

Comments
 (0)