* {@code KEYS} is supported for standalone and clustered (sharded) Redis operation modes. * * @return batching strategy using {@code KEYS}. @@ -56,7 +56,7 @@ public abstract class BatchStrategies { /** * A {@link BatchStrategy} using a {@code SCAN} cursors and potentially multiple {@code DEL} commands to remove all * matching keys. This strategy allows a configurable batch size to optimize for scan batching. - *
+ ** Note that using the {@code SCAN} strategy might be not supported on all drivers and Redis operation modes. * * @return batching strategy using {@code SCAN}. diff --git a/src/main/java/org/springframework/data/redis/cache/BatchStrategy.java b/src/main/java/org/springframework/data/redis/cache/BatchStrategy.java index bb9fd46d1..4e4218f54 100644 --- a/src/main/java/org/springframework/data/redis/cache/BatchStrategy.java +++ b/src/main/java/org/springframework/data/redis/cache/BatchStrategy.java @@ -19,9 +19,9 @@ import org.springframework.data.redis.connection.RedisConnection; /** * A {@link BatchStrategy} to be used with {@link RedisCacheWriter}. - *
+ ** Mainly used to clear the cache. - *
+ ** Predefined strategies using the {@link BatchStrategies#keys() KEYS} or {@link BatchStrategies#scan(int) SCAN} * commands can be found in {@link BatchStrategies}. * diff --git a/src/main/java/org/springframework/data/redis/cache/RedisCache.java b/src/main/java/org/springframework/data/redis/cache/RedisCache.java index f820614e0..355b744ee 100644 --- a/src/main/java/org/springframework/data/redis/cache/RedisCache.java +++ b/src/main/java/org/springframework/data/redis/cache/RedisCache.java @@ -39,7 +39,7 @@ import org.springframework.util.ReflectionUtils; /** * {@link org.springframework.cache.Cache} implementation using for Redis as underlying store. - *
+ ** Use {@link RedisCacheManager} to create {@link RedisCache} instances. * * @author Christoph Strobl diff --git a/src/main/java/org/springframework/data/redis/cache/RedisCacheConfiguration.java b/src/main/java/org/springframework/data/redis/cache/RedisCacheConfiguration.java index d2b94cfff..8dd1c09df 100644 --- a/src/main/java/org/springframework/data/redis/cache/RedisCacheConfiguration.java +++ b/src/main/java/org/springframework/data/redis/cache/RedisCacheConfiguration.java @@ -362,6 +362,7 @@ public class RedisCacheConfiguration { *
* This cache manager creates caches by default upon first write. Empty caches are not visible on Redis due to how Redis * represents empty data structures. - *
+ ** Caches requiring a different {@link RedisCacheConfiguration} than the default configuration can be specified via * {@link RedisCacheManagerBuilder#withInitialCacheConfigurations(Map)}. * @@ -170,7 +170,7 @@ public class RedisCacheManager extends AbstractTransactionSupportingCacheManager *
* {@link RedisCacheManager#getMissingCache(String)} returns {@literal null} for any unconfigured
* {@link org.springframework.cache.Cache} instead of a new {@link RedisCache} instance. This allows eg.
* {@link org.springframework.cache.support.CompositeCacheManager} to chime in.
diff --git a/src/main/java/org/springframework/data/redis/connection/BitFieldSubCommands.java b/src/main/java/org/springframework/data/redis/connection/BitFieldSubCommands.java
index 63e47783b..93b4c02ef 100644
--- a/src/main/java/org/springframework/data/redis/connection/BitFieldSubCommands.java
+++ b/src/main/java/org/springframework/data/redis/connection/BitFieldSubCommands.java
@@ -113,7 +113,7 @@ public class BitFieldSubCommands implements Iterable
*
* @param node must not be {@literal null}.
* @return {@link Mono} wrapping server information.
diff --git a/src/main/java/org/springframework/data/redis/connection/ReactiveGeoCommands.java b/src/main/java/org/springframework/data/redis/connection/ReactiveGeoCommands.java
index 5ef6c2818..72c453526 100644
--- a/src/main/java/org/springframework/data/redis/connection/ReactiveGeoCommands.java
+++ b/src/main/java/org/springframework/data/redis/connection/ReactiveGeoCommands.java
@@ -17,8 +17,6 @@ package org.springframework.data.redis.connection;
import static org.springframework.data.redis.connection.RedisGeoCommands.*;
-import org.springframework.data.redis.domain.geo.GeoReference;
-import org.springframework.data.redis.domain.geo.GeoShape;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
@@ -43,6 +41,8 @@ import org.springframework.data.redis.connection.ReactiveRedisConnection.KeyComm
import org.springframework.data.redis.connection.ReactiveRedisConnection.MultiValueResponse;
import org.springframework.data.redis.connection.ReactiveRedisConnection.NumericResponse;
import org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs.Flag;
+import org.springframework.data.redis.domain.geo.GeoReference;
+import org.springframework.data.redis.domain.geo.GeoShape;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
@@ -1279,7 +1279,7 @@ public interface ReactiveGeoCommands {
/**
* Sets the geoset {@literal key}. Constructs a new command instance with all previously configured properties.
*
- * @param member must not be {@literal null}.
+ * @param reference must not be {@literal null}.
* @return a new {@link GeoSearchCommand} with {@literal key} applied.
*/
public GeoSearchCommand at(GeoReference
* Blocks connection until element available or {@code timeout} reached.
*
* @param commands must not be {@literal null}.
diff --git a/src/main/java/org/springframework/data/redis/connection/ReactivePubSubCommands.java b/src/main/java/org/springframework/data/redis/connection/ReactivePubSubCommands.java
index ec847efbc..9f62c180f 100644
--- a/src/main/java/org/springframework/data/redis/connection/ReactivePubSubCommands.java
+++ b/src/main/java/org/springframework/data/redis/connection/ReactivePubSubCommands.java
@@ -34,7 +34,7 @@ public interface ReactivePubSubCommands {
/**
* Creates a subscription for this connection. Connections can have multiple {@link ReactiveSubscription}s.
- *
* Use {@link #createSubscription(SubscriptionListener)} to get notified when the subscription completes.
*
* @return the subscription.
@@ -77,7 +77,7 @@ public interface ReactivePubSubCommands {
* Subscribes the connection to the given {@code channels}. Once subscribed, a connection enters listening mode and
* can only subscribe to other channels or unsubscribe. No other commands are accepted until the connection is
* unsubscribed.
- *
* Note that cancellation of the {@link Flux} will unsubscribe from {@code channels}.
*
* @param channels channel names, must not be {@literal null}.
@@ -89,7 +89,7 @@ public interface ReactivePubSubCommands {
* Subscribes the connection to all channels matching the given {@code patterns}. Once subscribed, a connection enters
* listening mode and can only subscribe to other channels or unsubscribe. No other commands are accepted until the
* connection is unsubscribed.
- *
* Note that cancellation of the {@link Flux} will unsubscribe from {@code patterns}.
*
* @param patterns channel name patterns, must not be {@literal null}.
diff --git a/src/main/java/org/springframework/data/redis/connection/ReactiveServerCommands.java b/src/main/java/org/springframework/data/redis/connection/ReactiveServerCommands.java
index 5051c0de0..7e19e2a04 100644
--- a/src/main/java/org/springframework/data/redis/connection/ReactiveServerCommands.java
+++ b/src/main/java/org/springframework/data/redis/connection/ReactiveServerCommands.java
@@ -96,7 +96,6 @@ public interface ReactiveServerCommands {
*
*
* @return {@link Mono} wrapping server information.
* @see Redis Documentation: INFO
diff --git a/src/main/java/org/springframework/data/redis/connection/ReactiveSetCommands.java b/src/main/java/org/springframework/data/redis/connection/ReactiveSetCommands.java
index ee9adcfdc..6bbd9df8c 100644
--- a/src/main/java/org/springframework/data/redis/connection/ReactiveSetCommands.java
+++ b/src/main/java/org/springframework/data/redis/connection/ReactiveSetCommands.java
@@ -576,7 +576,7 @@ public interface ReactiveSetCommands {
/**
* Creates a new {@link SMIsMemberCommand} given one or more {@literal values}.
*
- * @param value must not be {@literal null}.
+ * @param values must not be {@literal null}.
* @return a new {@link SMIsMemberCommand} for a {@literal value}.
*/
public static SMIsMemberCommand values(List
* A reactive Redis connection can have multiple subscriptions. If two or more subscriptions subscribe to the same
* target (channel/pattern) and one unsubscribes, then the other one will no longer receive messages for the target due
* to how Redis handled Pub/Sub subscription.
@@ -103,7 +103,7 @@ public interface ReactiveSubscription {
/**
* Retrieve the message stream emitting {@link Message messages}. The resulting message stream contains only messages
* for subscribed and registered {@link #getChannels() channels} and {@link #getPatterns() patterns}.
- *
* Stream publishing uses {@link reactor.core.publisher.ConnectableFlux} turning the stream into a hot sequence.
* Emission is paused if there is no demand. Messages received in that time are buffered. This stream terminates
* either if all subscribers unsubscribe or if this {@link Subscription} is {@link #cancel() is terminated}.
diff --git a/src/main/java/org/springframework/data/redis/connection/ReactiveZSetCommands.java b/src/main/java/org/springframework/data/redis/connection/ReactiveZSetCommands.java
index 367120cf9..90e3cc904 100644
--- a/src/main/java/org/springframework/data/redis/connection/ReactiveZSetCommands.java
+++ b/src/main/java/org/springframework/data/redis/connection/ReactiveZSetCommands.java
@@ -1540,7 +1540,7 @@ public interface ReactiveZSetCommands {
* Applies a {@link Duration timeout}. Constructs a new command instance with all previously configured properties.
*
* @param timeout value.
- * @param timeout must not be {@literal null}.
+ * @param timeUnit must not be {@literal null}.
* @return a new {@link BZPopCommand} with {@link Duration timeout} applied.
*/
public BZPopCommand blockingFor(long timeout, TimeUnit timeUnit) {
diff --git a/src/main/java/org/springframework/data/redis/connection/RedisClusterConfiguration.java b/src/main/java/org/springframework/data/redis/connection/RedisClusterConfiguration.java
index feabb2410..8a17a3184 100644
--- a/src/main/java/org/springframework/data/redis/connection/RedisClusterConfiguration.java
+++ b/src/main/java/org/springframework/data/redis/connection/RedisClusterConfiguration.java
@@ -67,8 +67,7 @@ public class RedisClusterConfiguration implements RedisConfiguration, ClusterCon
* clusterHostAndPorts[0] = 127.0.0.1:23679
* clusterHostAndPorts[1] = 127.0.0.1:23680 ...
*
- *
- *
* Blocks connection until element available or {@code timeout} reached.
*
* @param sourceKey must not be {@literal null}.
diff --git a/src/main/java/org/springframework/data/redis/connection/RedisPassword.java b/src/main/java/org/springframework/data/redis/connection/RedisPassword.java
index f9dba8189..dadaed582 100644
--- a/src/main/java/org/springframework/data/redis/connection/RedisPassword.java
+++ b/src/main/java/org/springframework/data/redis/connection/RedisPassword.java
@@ -27,9 +27,9 @@ import org.springframework.util.StringUtils;
/**
* Value object which may or may not contain a Redis password.
- *
* If a password is present, {@code isPresent()} will return {@code true} and {@code get()} will return the value.
- *
* The password is stored as character array.
*
* @author Mark Paluch
@@ -109,7 +109,7 @@ public class RedisPassword {
/**
* Map the password using a {@link Function} and return a {@link Optional} containing the mapped value.
- *
* Absent passwords return a {@link Optional#empty()}.
*
* @param mapper must not be {@literal null}.
@@ -124,7 +124,7 @@ public class RedisPassword {
/**
* Adopt the password to {@link Optional} containing the password value.
- *
* Absent passwords return a {@link Optional#empty()}.
*
* @return the {@link Optional} containing the password value.
diff --git a/src/main/java/org/springframework/data/redis/connection/RedisSentinelConfiguration.java b/src/main/java/org/springframework/data/redis/connection/RedisSentinelConfiguration.java
index c4e07653f..a758f8a36 100644
--- a/src/main/java/org/springframework/data/redis/connection/RedisSentinelConfiguration.java
+++ b/src/main/java/org/springframework/data/redis/connection/RedisSentinelConfiguration.java
@@ -67,8 +67,7 @@ public class RedisSentinelConfiguration implements RedisConfiguration, SentinelC
*
*
*
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: INFO
diff --git a/src/main/java/org/springframework/data/redis/connection/RedisStreamCommands.java b/src/main/java/org/springframework/data/redis/connection/RedisStreamCommands.java
index 7f50913c6..2efb2d9b5 100644
--- a/src/main/java/org/springframework/data/redis/connection/RedisStreamCommands.java
+++ b/src/main/java/org/springframework/data/redis/connection/RedisStreamCommands.java
@@ -87,9 +87,8 @@ public interface RedisStreamCommands {
}
/**
- * Append the given {@link MapRecord record} to the stream stored at {@link Record#getStream()}.
* Use {@link Expiration#seconds(long)} for {@code EX}.
*
* @see Redis Documentation: MULTI
*/
diff --git a/src/main/java/org/springframework/data/redis/connection/RedisZSetCommands.java b/src/main/java/org/springframework/data/redis/connection/RedisZSetCommands.java
index 9c299a797..541e7dc81 100644
--- a/src/main/java/org/springframework/data/redis/connection/RedisZSetCommands.java
+++ b/src/main/java/org/springframework/data/redis/connection/RedisZSetCommands.java
@@ -577,7 +577,7 @@ public interface RedisZSetCommands {
* @param key must not be {@literal null}.
* @param score the score.
* @param value the value.
- * @param args must not be {@literal null} use {@link ZAddArgs#none()} instead.
+ * @param args must not be {@literal null} use {@link ZAddArgs#empty()} instead.
* @return {@literal null} when used in pipeline / transaction.
* @since 2.5
* @see Redis Documentation: ZADD
@@ -604,7 +604,7 @@ public interface RedisZSetCommands {
*
* @param key must not be {@literal null}.
* @param tuples must not be {@literal null}.
- * @param args must not be {@literal null} use {@link ZAddArgs#none()} instead.
+ * @param args must not be {@literal null} use {@link ZAddArgs#empty()} instead.
* @return {@literal null} when used in pipeline / transaction.
* @since 2.5
* @see Redis Documentation: ZADD
@@ -1308,7 +1308,6 @@ public interface RedisZSetCommands {
/**
* Union sorted {@code sets}.
*
- * @param destKey must not be {@literal null}.
* @param sets must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @since 2.6
@@ -1320,7 +1319,6 @@ public interface RedisZSetCommands {
/**
* Union sorted {@code sets}.
*
- * @param destKey must not be {@literal null}.
* @param sets must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @since 2.6
diff --git a/src/main/java/org/springframework/data/redis/connection/SortParameters.java b/src/main/java/org/springframework/data/redis/connection/SortParameters.java
index 819770bb9..9dee5e4bf 100644
--- a/src/main/java/org/springframework/data/redis/connection/SortParameters.java
+++ b/src/main/java/org/springframework/data/redis/connection/SortParameters.java
@@ -72,17 +72,17 @@ public interface SortParameters {
Boolean isAlphabetic();
/**
- * Returns the pattern (if set) for sorting by external keys (BY). Can be null if nothing is specified.
+ * Returns the pattern (if set) for sorting by external keys ({@code BY}). Can be null if nothing is specified.
*
- * @return BY pattern. {@literal null} if not set.
+ * @return {@code BY} pattern. {@literal null} if not set.
*/
@Nullable
byte[] getByPattern();
/**
- * Returns the pattern (if set) for retrieving external keys (GET). Can be null if nothing is specified.
+ * Returns the pattern (if set) for retrieving external keys ({@code GET}). Can be null if nothing is specified.
*
- * @return GET pattern. {@literal null} if not set.
+ * @return {@code GET} pattern. {@literal null} if not set.
*/
@Nullable
byte[][] getGetPattern();
diff --git a/src/main/java/org/springframework/data/redis/connection/StringRedisConnection.java b/src/main/java/org/springframework/data/redis/connection/StringRedisConnection.java
index d4640e886..11e6a1825 100644
--- a/src/main/java/org/springframework/data/redis/connection/StringRedisConnection.java
+++ b/src/main/java/org/springframework/data/redis/connection/StringRedisConnection.java
@@ -144,7 +144,7 @@ public interface StringRedisConnection extends RedisConnection {
* @param replace whether to replace existing keys.
* @return {@literal null} when used in pipeline / transaction.
* @see Redis Documentation: COPY
- * @see RedisKeyCommands#copy(byte[], byte[])
+ * @see RedisKeyCommands#copy(byte[], byte[], boolean)
*/
Boolean copy(String sourceKey, String targetKey, boolean replace);
@@ -1224,7 +1224,7 @@ public interface StringRedisConnection extends RedisConnection {
* @param key must not be {@literal null}.
* @param score must not be {@literal null}.
* @param value must not be {@literal null}.
- * @param args must not be {@literal null} use {@link ZAddArgs#none()} instead.
+ * @param args must not be {@literal null} use {@link ZAddArgs#empty()} instead.
* @return {@literal null} when used in pipeline / transaction.
* @since 2.5
* @see Redis Documentation: ZADD
@@ -1249,7 +1249,7 @@ public interface StringRedisConnection extends RedisConnection {
*
* @param key must not be {@literal null}.
* @param tuples must not be {@literal null}.
- * @param args must not be {@literal null} use {@link ZAddArgs#none()} instead.
+ * @param args must not be {@literal null} use {@link ZAddArgs#empty()} instead.
* @return {@literal null} when used in pipeline / transaction.
* @since 2.5
* @see Redis Documentation: ZADD
@@ -1792,7 +1792,6 @@ public interface StringRedisConnection extends RedisConnection {
/**
* Union sorted {@code sets}.
*
- * @param destKey must not be {@literal null}.
* @param sets must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @since 2.6
@@ -1804,7 +1803,6 @@ public interface StringRedisConnection extends RedisConnection {
/**
* Union sorted {@code sets}.
*
- * @param destKey must not be {@literal null}.
* @param sets must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @since 2.6
@@ -1935,7 +1933,7 @@ public interface StringRedisConnection extends RedisConnection {
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
- * @param range can be {@literal null}.
+ * @param limit can be {@literal null}.
* @return
* @since 1.6
* @see Redis Documentation: ZRANGEBYLEX
@@ -1971,12 +1969,12 @@ public interface StringRedisConnection extends RedisConnection {
}
/**
- * Get all the elements in {@link Range} from the sorted set at {@literal key} in reversed lexicographical ordering. Result is
- * limited via {@link Limit}.
+ * Get all the elements in {@link Range} from the sorted set at {@literal key} in reversed lexicographical ordering.
+ * Result is limited via {@link Limit}.
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
- * @param range can be {@literal null}.
+ * @param limit must not be {@literal null}.
* @return
* @since 2.4
* @see Redis Documentation: ZREVRANGEBYLEX
diff --git a/src/main/java/org/springframework/data/redis/connection/SubscriptionListener.java b/src/main/java/org/springframework/data/redis/connection/SubscriptionListener.java
index fe93c9dee..1d00bf9cc 100644
--- a/src/main/java/org/springframework/data/redis/connection/SubscriptionListener.java
+++ b/src/main/java/org/springframework/data/redis/connection/SubscriptionListener.java
@@ -17,7 +17,7 @@ package org.springframework.data.redis.connection;
/**
* Listener for subscription notifications.
- *
* Subscription notifications are reported by Redis as confirmation for subscribe and unsubscribe operations for
* channels and patterns.
*
diff --git a/src/main/java/org/springframework/data/redis/connection/jedis/JedisClientConfiguration.java b/src/main/java/org/springframework/data/redis/connection/jedis/JedisClientConfiguration.java
index de35a5105..8c5b5592d 100644
--- a/src/main/java/org/springframework/data/redis/connection/jedis/JedisClientConfiguration.java
+++ b/src/main/java/org/springframework/data/redis/connection/jedis/JedisClientConfiguration.java
@@ -33,7 +33,7 @@ import org.springframework.util.Assert;
/**
* Redis client configuration for jedis. This configuration provides optional configuration elements such as
* {@link SSLSocketFactory} and {@link JedisPoolConfig} specific to jedis client features.
- *
* Providing optional elements allows a more specific configuration of the client:
*
* Applies only to single node Redis. Sentinel and Cluster modes use always connection-pooling regardless of the
* pooling setting.
*
diff --git a/src/main/java/org/springframework/data/redis/connection/jedis/JedisConnectionFactory.java b/src/main/java/org/springframework/data/redis/connection/jedis/JedisConnectionFactory.java
index f7af5cde4..272daa543 100644
--- a/src/main/java/org/springframework/data/redis/connection/jedis/JedisConnectionFactory.java
+++ b/src/main/java/org/springframework/data/redis/connection/jedis/JedisConnectionFactory.java
@@ -702,7 +702,7 @@ public class JedisConnectionFactory implements InitializingBean, DisposableBean,
/**
* Indicates the use of a connection pool.
- *
* Applies only to single node Redis. Sentinel and Cluster modes use always connection-pooling regardless of the
* pooling setting.
*
diff --git a/src/main/java/org/springframework/data/redis/connection/jedis/StreamConverters.java b/src/main/java/org/springframework/data/redis/connection/jedis/StreamConverters.java
index f95661edc..984c90eb8 100644
--- a/src/main/java/org/springframework/data/redis/connection/jedis/StreamConverters.java
+++ b/src/main/java/org/springframework/data/redis/connection/jedis/StreamConverters.java
@@ -40,7 +40,7 @@ import org.springframework.data.redis.connection.stream.StreamRecords;
/**
* Converters for Redis Stream-specific types.
- *
* Converters typically convert between value objects/argument objects retaining the actual types of values (i.e. no
* serialization/deserialization happens here).
*
diff --git a/src/main/java/org/springframework/data/redis/connection/lettuce/DefaultLettucePool.java b/src/main/java/org/springframework/data/redis/connection/lettuce/DefaultLettucePool.java
index aebc4b35f..3a5d18b01 100644
--- a/src/main/java/org/springframework/data/redis/connection/lettuce/DefaultLettucePool.java
+++ b/src/main/java/org/springframework/data/redis/connection/lettuce/DefaultLettucePool.java
@@ -64,7 +64,7 @@ public class DefaultLettucePool implements LettucePool, InitializingBean {
public DefaultLettucePool() {}
/**
- * Uses the {@link Config} and {@link RedisClient} defaults for configuring the connection pool
+ * Uses the {@link GenericObjectPoolConfig} defaults for configuring the connection pool
*
* @param hostName The Redis host
* @param port The Redis port
diff --git a/src/main/java/org/springframework/data/redis/connection/lettuce/LettuceConnectionFactory.java b/src/main/java/org/springframework/data/redis/connection/lettuce/LettuceConnectionFactory.java
index cd2463f80..a7fb2c196 100644
--- a/src/main/java/org/springframework/data/redis/connection/lettuce/LettuceConnectionFactory.java
+++ b/src/main/java/org/springframework/data/redis/connection/lettuce/LettuceConnectionFactory.java
@@ -864,7 +864,7 @@ public class LettuceConnectionFactory
* Returns the native {@link AbstractRedisClient} used by this instance. The client is initialized as part of
* {@link #afterPropertiesSet() the bean initialization lifecycle} and only available when this connection factory is
* initialized.
- *
* Depending on the configuration, the client can be either {@link RedisClient} or {@link RedisClusterClient}.
*
* @return the native {@link AbstractRedisClient}. Can be {@literal null} if not initialized.
@@ -881,7 +881,7 @@ public class LettuceConnectionFactory
* Returns the native {@link AbstractRedisClient} used by this instance. The client is initialized as part of
* {@link #afterPropertiesSet() the bean initialization lifecycle} and only available when this connection factory is
* initialized. Throws {@link IllegalStateException} if not yet initialized.
- *
* Depending on the configuration, the client can be either {@link RedisClient} or {@link RedisClusterClient}.
*
* @return the native {@link AbstractRedisClient}.
diff --git a/src/main/java/org/springframework/data/redis/connection/lettuce/LettuceConnectionProvider.java b/src/main/java/org/springframework/data/redis/connection/lettuce/LettuceConnectionProvider.java
index b81618938..0db9b43a0 100644
--- a/src/main/java/org/springframework/data/redis/connection/lettuce/LettuceConnectionProvider.java
+++ b/src/main/java/org/springframework/data/redis/connection/lettuce/LettuceConnectionProvider.java
@@ -23,13 +23,13 @@ import java.util.concurrent.CompletionStage;
/**
* Defines a provider for Lettuce connections.
- *
* This interface is typically used to encapsulate a native factory which returns a {@link StatefulConnection
* connection} of on each invocation.
- *
* Connection providers may create a new connection on each invocation or return pooled instances. Each obtained
* connection must be released through its connection provider to allow disposal or release back to the pool.
- *
* Connection providers are usually associated with a {@link io.lettuce.core.codec.RedisCodec} to create connections
* with an appropriate codec.
*
diff --git a/src/main/java/org/springframework/data/redis/connection/lettuce/LettucePoolingConnectionProvider.java b/src/main/java/org/springframework/data/redis/connection/lettuce/LettucePoolingConnectionProvider.java
index 61a7747c3..bd54c1458 100644
--- a/src/main/java/org/springframework/data/redis/connection/lettuce/LettucePoolingConnectionProvider.java
+++ b/src/main/java/org/springframework/data/redis/connection/lettuce/LettucePoolingConnectionProvider.java
@@ -42,11 +42,11 @@ import org.springframework.util.Assert;
/**
* {@link LettuceConnectionProvider} with connection pooling support. This connection provider holds multiple pools (one
* per connection type and allocation type (synchronous/asynchronous)) for contextualized connection allocation.
- *
* Each allocated connection is tracked and to be returned into the pool which created the connection. Instances of this
* class require {@link #destroy() disposal} to de-allocate lingering connections that were not returned to the pool and
* to close the pools.
- *
* This provider maintains separate pools due to the allocation nature (synchronous/asynchronous). Asynchronous
* connection pooling requires a non-blocking allocation API. Connections requested asynchronously can be returned
* synchronously and vice versa. A connection obtained synchronously is returned to the synchronous pool even if
diff --git a/src/main/java/org/springframework/data/redis/connection/lettuce/LettuceReactiveSubscription.java b/src/main/java/org/springframework/data/redis/connection/lettuce/LettuceReactiveSubscription.java
index 12c782138..171af6efe 100644
--- a/src/main/java/org/springframework/data/redis/connection/lettuce/LettuceReactiveSubscription.java
+++ b/src/main/java/org/springframework/data/redis/connection/lettuce/LettuceReactiveSubscription.java
@@ -254,7 +254,7 @@ class LettuceReactiveSubscription implements ReactiveSubscription {
* Create a message stream from connect {@link Function}. Multiple calls to this method are lock-free synchronized.
* The first successful caller creates the actual stream. Other concurrent callers that do not pass the
* synchronization use the stream created by the first successful caller.
- *
* The stream registers a disposal function upon subscription for external {@link #terminate() termination}.
*
* @param connectFunction
diff --git a/src/main/java/org/springframework/data/redis/connection/lettuce/LettuceScanCursor.java b/src/main/java/org/springframework/data/redis/connection/lettuce/LettuceScanCursor.java
index cecbbe777..d53dd5bd2 100644
--- a/src/main/java/org/springframework/data/redis/connection/lettuce/LettuceScanCursor.java
+++ b/src/main/java/org/springframework/data/redis/connection/lettuce/LettuceScanCursor.java
@@ -25,7 +25,7 @@ import org.springframework.lang.Nullable;
/**
* Lettuce-specific {@link ScanCursor} extension that maintains the cursor state that is required for stateful-scanning
* across a Redis Cluster.
- *
* The cursor state uses Lettuce's stateful {@link io.lettuce.core.ScanCursor} to keep track of scanning progress.
*
* @author Mark Paluch
diff --git a/src/main/java/org/springframework/data/redis/connection/lettuce/StreamConverters.java b/src/main/java/org/springframework/data/redis/connection/lettuce/StreamConverters.java
index 48c429f87..58436d69c 100644
--- a/src/main/java/org/springframework/data/redis/connection/lettuce/StreamConverters.java
+++ b/src/main/java/org/springframework/data/redis/connection/lettuce/StreamConverters.java
@@ -42,7 +42,7 @@ import org.springframework.util.NumberUtils;
/**
* Converters for Redis Stream-specific types.
- *
* Converters typically convert between value objects/argument objects retaining the actual types of values (i.e. no
* serialization/deserialization happens here).
*
diff --git a/src/main/java/org/springframework/data/redis/connection/stream/ByteBufferRecord.java b/src/main/java/org/springframework/data/redis/connection/stream/ByteBufferRecord.java
index 14484a4c3..4ad32de0e 100644
--- a/src/main/java/org/springframework/data/redis/connection/stream/ByteBufferRecord.java
+++ b/src/main/java/org/springframework/data/redis/connection/stream/ByteBufferRecord.java
@@ -94,7 +94,7 @@ public interface ByteBufferRecord extends MapRecord
*
* @author Costin Leau
* @author Christoph Strobl
diff --git a/src/main/java/org/springframework/data/redis/core/BoundListOperations.java b/src/main/java/org/springframework/data/redis/core/BoundListOperations.java
index 7d21a8fe0..d26017cdb 100644
--- a/src/main/java/org/springframework/data/redis/core/BoundListOperations.java
+++ b/src/main/java/org/springframework/data/redis/core/BoundListOperations.java
@@ -159,7 +159,7 @@ public interface BoundListOperations
* Blocks connection until element available or {@code timeout} reached.
*
* @param from must not be {@literal null}.
@@ -177,7 +177,7 @@ public interface BoundListOperations
* Blocks connection until element available or {@code timeout} reached.
*
* @param from must not be {@literal null}.
diff --git a/src/main/java/org/springframework/data/redis/core/BoundSetOperations.java b/src/main/java/org/springframework/data/redis/core/BoundSetOperations.java
index 0ef9a697d..91e5e4d56 100644
--- a/src/main/java/org/springframework/data/redis/core/BoundSetOperations.java
+++ b/src/main/java/org/springframework/data/redis/core/BoundSetOperations.java
@@ -92,7 +92,6 @@ public interface BoundSetOperations
- * Typically used by {@link RedisTemplate} sort methods.
+ * Typically used by {@link RedisTemplate} {@code sort} methods.
*
* @author Costin Leau
*/
diff --git a/src/main/java/org/springframework/data/redis/core/Cursor.java b/src/main/java/org/springframework/data/redis/core/Cursor.java
index c75a7448d..61731ea8e 100644
--- a/src/main/java/org/springframework/data/redis/core/Cursor.java
+++ b/src/main/java/org/springframework/data/redis/core/Cursor.java
@@ -20,11 +20,11 @@ import org.springframework.data.util.CloseableIterator;
/**
* Cursor abstraction to scan over the keyspace or elements within a data structure using a variant of a {@code SCAN}
* command.
- *
* Using a Java 8 {@link #stream() java.util.stream.Stream} allows to apply additional
- * {@link java.util.stream.Stream#filter(java.util.function.Predicate) filters} and {@link java.util.stream.Stream#limit(long) limits} to
- * the underlying {@link Cursor}.
- *
* Make sure to {@link CloseableIterator#close() close} the cursor when done as this allows implementations to clean up
* any resources they need to keep open to iterate over elements (eg. by using a try-with-resource statement).
*
diff --git a/src/main/java/org/springframework/data/redis/core/HashMapperProvider.java b/src/main/java/org/springframework/data/redis/core/HashMapperProvider.java
index 9f6e6b935..54db980c8 100644
--- a/src/main/java/org/springframework/data/redis/core/HashMapperProvider.java
+++ b/src/main/java/org/springframework/data/redis/core/HashMapperProvider.java
@@ -19,7 +19,7 @@ import org.springframework.data.redis.hash.HashMapper;
/**
* Function that returns a {@link HashMapper} for a given {@link Class type}.
- *
* Implementors of this interface can return a generic or a specific {@link HashMapper} implementation, depending on the
* serialization strategy for the requested {@link Class target type}.
*
diff --git a/src/main/java/org/springframework/data/redis/core/ListOperations.java b/src/main/java/org/springframework/data/redis/core/ListOperations.java
index 73d8a4888..ae2c09473 100644
--- a/src/main/java/org/springframework/data/redis/core/ListOperations.java
+++ b/src/main/java/org/springframework/data/redis/core/ListOperations.java
@@ -277,7 +277,7 @@ public interface ListOperations
* Blocks connection until element available or {@code timeout} reached.
*
* @param from must not be {@literal null}.
@@ -303,7 +303,7 @@ public interface ListOperations
* Blocks connection until element available or {@code timeout} reached.
*
* @param sourceKey must not be {@literal null}.
@@ -329,7 +329,7 @@ public interface ListOperations
* Blocks connection until element available or {@code timeout} reached.
*
* @param sourceKey must not be {@literal null}.
diff --git a/src/main/java/org/springframework/data/redis/core/ReactiveListOperations.java b/src/main/java/org/springframework/data/redis/core/ReactiveListOperations.java
index efcb764c9..363323583 100644
--- a/src/main/java/org/springframework/data/redis/core/ReactiveListOperations.java
+++ b/src/main/java/org/springframework/data/redis/core/ReactiveListOperations.java
@@ -209,7 +209,7 @@ public interface ReactiveListOperations
* Blocks connection until element available or {@code timeout} reached.
*
* @param from must not be {@literal null}.
@@ -234,7 +234,7 @@ public interface ReactiveListOperations
* Blocks connection until element available or {@code timeout} reached.
*
* @param sourceKey must not be {@literal null}.
diff --git a/src/main/java/org/springframework/data/redis/core/ReactiveRedisSessionCallback.java b/src/main/java/org/springframework/data/redis/core/ReactiveRedisSessionCallback.java
index bf55835ac..85cefb6a4 100644
--- a/src/main/java/org/springframework/data/redis/core/ReactiveRedisSessionCallback.java
+++ b/src/main/java/org/springframework/data/redis/core/ReactiveRedisSessionCallback.java
@@ -23,7 +23,7 @@ import org.springframework.data.redis.connection.ReactiveRedisConnection;
* Generic callback interface for code that wants to use the same {@link ReactiveRedisConnection} avoiding connection
* allocation overhead upon each Template API method call. Allows to execute any number of operations on a single
* {@link ReactiveRedisConnection}, using any type and number of commands.
- *
* This is particularly useful for issuing multiple calls on the same connection.
*
* @param
* Allows for returning a result object created within the callback, i.e. a domain object or a collection of domain
* objects.
*
diff --git a/src/main/java/org/springframework/data/redis/core/ReactiveRedisTemplate.java b/src/main/java/org/springframework/data/redis/core/ReactiveRedisTemplate.java
index 523404ad4..0997e8452 100644
--- a/src/main/java/org/springframework/data/redis/core/ReactiveRedisTemplate.java
+++ b/src/main/java/org/springframework/data/redis/core/ReactiveRedisTemplate.java
@@ -49,10 +49,10 @@ import org.springframework.util.ClassUtils;
/**
* Central abstraction for reactive Redis data access implementing {@link ReactiveRedisOperations}.
- *
* Performs automatic serialization/deserialization between the given objects and the underlying binary data in the
* Redis store.
- *
* Note that while the template is generified, it is up to the serializers/deserializers to properly convert the given
* Objects to and from binary data.
*
diff --git a/src/main/java/org/springframework/data/redis/core/ReactiveSetOperations.java b/src/main/java/org/springframework/data/redis/core/ReactiveSetOperations.java
index c18929d6d..3070956a9 100644
--- a/src/main/java/org/springframework/data/redis/core/ReactiveSetOperations.java
+++ b/src/main/java/org/springframework/data/redis/core/ReactiveSetOperations.java
@@ -105,7 +105,7 @@ public interface ReactiveSetOperations
*
* @see Redis Documentation: MULTI
*/
@@ -580,7 +579,6 @@ public interface RedisOperations
* Performs automatic serialization/deserialization between the given objects and the underlying binary data in the
* Redis store. By default, it uses Java serialization for its objects (through {@link JdkSerializationRedisSerializer}
* ). For String intensive operations consider the dedicated {@link StringRedisTemplate}.
- *
* The central method is execute, supporting Redis access code implementing the {@link RedisCallback} interface. It
* provides {@link RedisConnection} handling such that neither the {@link RedisCallback} implementation nor the calling
* code needs to explicitly care about retrieving/closing Redis connections, or handling Connection lifecycle
* exceptions. For typical single step actions, there are various convenience methods.
- *
* Once configured, this class is thread-safe.
- *
* Note that while the template is generified, it is up to the serializers/deserializers to properly convert the given
* Objects to and from binary data.
- *
* This is the central class in Redis support.
*
* @author Costin Leau
@@ -83,7 +83,6 @@ import org.springframework.util.CollectionUtils;
* @author Mark Paluch
* @author Denis Zavedeev
* @author ihaohong
- *
* @param
* This utility can use generic a {@link HashMapper} or adapt specifically to {@link ObjectHashMapper}'s requirement to
* convert incoming data into byte arrays. This class can be subclassed to override template methods for specific object
* mapping strategies.
diff --git a/src/main/java/org/springframework/data/redis/core/StringRedisTemplate.java b/src/main/java/org/springframework/data/redis/core/StringRedisTemplate.java
index 65717759f..1f99fcf94 100644
--- a/src/main/java/org/springframework/data/redis/core/StringRedisTemplate.java
+++ b/src/main/java/org/springframework/data/redis/core/StringRedisTemplate.java
@@ -20,13 +20,12 @@ import org.springframework.data.redis.connection.RedisConnection;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.connection.StringRedisConnection;
import org.springframework.data.redis.serializer.RedisSerializer;
-import org.springframework.data.redis.serializer.StringRedisSerializer;
/**
* String-focused extension of RedisTemplate. Since most operations against Redis are String based, this class provides
* a dedicated class that minimizes configuration of its more generic {@link RedisTemplate template} especially in terms
* of serializers.
- *
* Note that this template exposes the {@link RedisConnection} used by the {@link RedisCallback} as a
* {@link StringRedisConnection}.
*
diff --git a/src/main/java/org/springframework/data/redis/core/convert/MappingRedisConverter.java b/src/main/java/org/springframework/data/redis/core/convert/MappingRedisConverter.java
index f7d0bdd17..9408d22e3 100644
--- a/src/main/java/org/springframework/data/redis/core/convert/MappingRedisConverter.java
+++ b/src/main/java/org/springframework/data/redis/core/convert/MappingRedisConverter.java
@@ -80,8 +80,8 @@ import org.springframework.util.comparator.NullSafeComparator;
* @Id String id;
* String firstname;
*
- * List
* Provides template support and callback for low-level access.
*/
@org.springframework.lang.NonNullApi
diff --git a/src/main/java/org/springframework/data/redis/core/types/Expiration.java b/src/main/java/org/springframework/data/redis/core/types/Expiration.java
index cba082ad6..9fa489df1 100644
--- a/src/main/java/org/springframework/data/redis/core/types/Expiration.java
+++ b/src/main/java/org/springframework/data/redis/core/types/Expiration.java
@@ -128,7 +128,7 @@ public class Expiration {
/**
* Obtain an {@link Expiration} that indicates to keep the existing one. Eg. when sending a {@code SET} command.
- *
* NOTE: Please follow the documentation of the individual commands to see if {@link #keepTtl()} is
* applicable.
*
diff --git a/src/main/java/org/springframework/data/redis/hash/Jackson2HashMapper.java b/src/main/java/org/springframework/data/redis/hash/Jackson2HashMapper.java
index 819a76dc8..b6652b4f3 100644
--- a/src/main/java/org/springframework/data/redis/hash/Jackson2HashMapper.java
+++ b/src/main/java/org/springframework/data/redis/hash/Jackson2HashMapper.java
@@ -59,10 +59,9 @@ import com.fasterxml.jackson.databind.ser.std.DateSerializer;
* {@link ObjectMapper} based {@link HashMapper} implementation that allows flattening. Given an entity {@code Person}
* with an {@code Address} like below the flattening will create individual hash entries for all nested properties and
* resolve complex types into simple types, as far as possible.
- *
* Flattening requires all property names to not interfere with JSON paths. Using dots or brackets in map keys or as
* property names is not supported using flattening. The resulting hash cannot be mapped back into an Object.
- *
* NOTE: We highly recommend constructing individual {@link ObjectHashMapper} instances for customization
* purposes. This accessor is only meant as a fallback for code paths which need simple type coercion but cannot
diff --git a/src/main/java/org/springframework/data/redis/listener/ReactiveRedisMessageListenerContainer.java b/src/main/java/org/springframework/data/redis/listener/ReactiveRedisMessageListenerContainer.java
index e8061a03c..2424a4f3b 100644
--- a/src/main/java/org/springframework/data/redis/listener/ReactiveRedisMessageListenerContainer.java
+++ b/src/main/java/org/springframework/data/redis/listener/ReactiveRedisMessageListenerContainer.java
@@ -56,11 +56,11 @@ import org.springframework.util.ObjectUtils;
* Container providing a stream of {@link ChannelMessage} for messages received via Redis Pub/Sub listeners. The stream
* is infinite and registers Redis subscriptions. Handles the low level details of listening, converting and message
* dispatching.
- *
* Note the container allocates a single connection when it is created and releases the connection on
* {@link #destroy()}. Connections are allocated eagerly to not interfere with non-blocking use during application
* operations. Using reactive infrastructure allows usage of a single connection due to channel multiplexing.
- *
* This class is thread-safe and allows subscription by multiple concurrent threads.
*
* @author Mark Paluch
@@ -166,7 +166,7 @@ public class ReactiveRedisMessageListenerContainer implements DisposableBean {
* {@link Mono} completes. Messages and channel names are treated as {@link String}. The message stream subscribes
* lazily to the Redis channels and unsubscribes if the inner {@link org.reactivestreams.Subscription} is
* {@link org.reactivestreams.Subscription#cancel() cancelled}.
- *
* The returned {@link Mono} completes once the connection has been subscribed to the given {@link Topic topics}. Note
* that cancelling the returned {@link Mono} can leave the connection in a subscribed state.
*
@@ -209,7 +209,7 @@ public class ReactiveRedisMessageListenerContainer implements DisposableBean {
* {@link Mono} completes. Messages, pattern, and channel names are treated as {@link String}. The message stream
* subscribes lazily to the Redis channels and unsubscribes if the inner {@link org.reactivestreams.Subscription} is
* {@link org.reactivestreams.Subscription#cancel() cancelled}.
- *
* The returned {@link Mono} completes once the connection has been subscribed to the given {@link Topic topics}. Note
* that cancelling the returned {@link Mono} can leave the connection in a subscribed state.
*
diff --git a/src/main/java/org/springframework/data/redis/listener/adapter/MessageListenerAdapter.java b/src/main/java/org/springframework/data/redis/listener/adapter/MessageListenerAdapter.java
index 2a0ad0d7b..b3e97e14e 100644
--- a/src/main/java/org/springframework/data/redis/listener/adapter/MessageListenerAdapter.java
+++ b/src/main/java/org/springframework/data/redis/listener/adapter/MessageListenerAdapter.java
@@ -43,13 +43,13 @@ import org.springframework.util.StringUtils;
* Message listener adapter that delegates the handling of messages to target listener methods via reflection, with
* flexible message type conversion. Allows listener methods to operate on message content types, completely independent
* from the Redis API.
- *
* Make sure to call {@link #afterPropertiesSet()} after setting all the parameters on the adapter.
- *
* Note that if the underlying "delegate" is implementing {@link MessageListener}, the adapter will delegate to it and
* allow an invalid method to be specified. However if it is not, the method becomes mandatory. This lenient behavior
* allows the adapter to be used uniformly across existing listeners and message POJOs.
- *
* Modeled as much as possible after the JMS MessageListenerAdapter in Spring Framework.
*
* By default, the content of incoming Redis messages gets extracted before being passed into the target listener
@@ -93,7 +93,6 @@ import org.springframework.util.StringUtils;
* @author Thomas Darimont
* @author Christoph Strobl
* @author Mark Paluch
- * @see org.springframework.jms.listener.adapter.MessageListenerAdapter
*/
public class MessageListenerAdapter implements InitializingBean, MessageListener {
diff --git a/src/main/java/org/springframework/data/redis/repository/package-info.java b/src/main/java/org/springframework/data/redis/repository/package-info.java
deleted file mode 100644
index ce2277922..000000000
--- a/src/main/java/org/springframework/data/redis/repository/package-info.java
+++ /dev/null
@@ -1,6 +0,0 @@
-/**
- * Redis specific implementation of repository support
- */
-@org.springframework.lang.NonNullApi
-@org.springframework.lang.NonNullFields
-package org.springframework.data.redis.repository;
diff --git a/src/main/java/org/springframework/data/redis/repository/query/ExampleQueryMapper.java b/src/main/java/org/springframework/data/redis/repository/query/ExampleQueryMapper.java
index a59d2f9e5..dd605d89c 100644
--- a/src/main/java/org/springframework/data/redis/repository/query/ExampleQueryMapper.java
+++ b/src/main/java/org/springframework/data/redis/repository/query/ExampleQueryMapper.java
@@ -40,11 +40,11 @@ import org.springframework.util.StringUtils;
/**
* Mapper for Query-by-Example examples to an actual query.
- *
* This mapper creates a {@link RedisOperationChain} for a given {@link Example} considering exact matches,
* {@link PropertyValueTransformer value transformations} and {@link MatchMode} for indexed simple and nested type
* properties. {@link java.util.Map} and {@link java.util.Collection} properties are not considered.
- *
* Example matching is limited to case-sensitive and exact matches only.
*
* @author Mark Paluch
diff --git a/src/main/java/org/springframework/data/redis/repository/support/QueryByExampleRedisExecutor.java b/src/main/java/org/springframework/data/redis/repository/support/QueryByExampleRedisExecutor.java
index c41fb3eac..1e160c61e 100644
--- a/src/main/java/org/springframework/data/redis/repository/support/QueryByExampleRedisExecutor.java
+++ b/src/main/java/org/springframework/data/redis/repository/support/QueryByExampleRedisExecutor.java
@@ -38,7 +38,7 @@ import org.springframework.util.Assert;
/**
* Repository fragment implementing Redis {@link QueryByExampleExecutor Query-by-Example} operations.
- *
* This executor uses {@link ExampleQueryMapper} to map {@link Example}s into {@link KeyValueQuery} to execute its query
* methods.
*
diff --git a/src/main/java/org/springframework/data/redis/serializer/RedisSerializationContext.java b/src/main/java/org/springframework/data/redis/serializer/RedisSerializationContext.java
index 11ba52783..ff892a1d1 100644
--- a/src/main/java/org/springframework/data/redis/serializer/RedisSerializationContext.java
+++ b/src/main/java/org/springframework/data/redis/serializer/RedisSerializationContext.java
@@ -21,7 +21,7 @@ import org.springframework.util.Assert;
/**
* Serialization context for reactive use.
- *
* This context provides {@link SerializationPair}s for key, value, hash-key (field), hash-value and {@link String}
* serialization and deserialization.
*
diff --git a/src/main/java/org/springframework/data/redis/stream/DefaultStreamMessageListenerContainer.java b/src/main/java/org/springframework/data/redis/stream/DefaultStreamMessageListenerContainer.java
index f2fce7ca3..b99c75d2c 100644
--- a/src/main/java/org/springframework/data/redis/stream/DefaultStreamMessageListenerContainer.java
+++ b/src/main/java/org/springframework/data/redis/stream/DefaultStreamMessageListenerContainer.java
@@ -45,7 +45,7 @@ import org.springframework.util.ObjectUtils;
/**
* Simple {@link Executor} based {@link StreamMessageListenerContainer} implementation for running {@link Task tasks} to
* poll on Redis Streams.
- *
* This message container creates long-running tasks that are executed on {@link Executor}.
*
* @author Mark Paluch
diff --git a/src/main/java/org/springframework/data/redis/stream/StreamMessageListenerContainer.java b/src/main/java/org/springframework/data/redis/stream/StreamMessageListenerContainer.java
index 9684c2af3..dc1d7ca8f 100644
--- a/src/main/java/org/springframework/data/redis/stream/StreamMessageListenerContainer.java
+++ b/src/main/java/org/springframework/data/redis/stream/StreamMessageListenerContainer.java
@@ -41,7 +41,7 @@ import org.springframework.util.ErrorHandler;
/**
* Abstraction used by the framework representing a message listener container. Not meant to be
* implemented externally.
- *
* Once created, a {@link StreamMessageListenerContainer} can subscribe to a Redis Stream and consume incoming
* {@link Record messages}. {@link StreamMessageListenerContainer} allows multiple stream read requests and returns a
* {@link Subscription} handle per read request. Cancelling the {@link Subscription} terminates eventually background
@@ -79,16 +79,16 @@ import org.springframework.util.ErrorHandler;
* Note: Using {@link ReadOffset#latest()} bears the chance of dropped messages as messages can arrive in the
* time during polling is suspended. Use messagedId's as offset or {@link ReadOffset#lastConsumed()} to minimize the
* chance of message loss.
- *
* {@link StreamMessageListenerContainer} requires a {@link Executor} to fork long-running polling tasks on a different
* {@link Thread}. This thread is used as event loop to poll for stream messages and invoke the
* {@link StreamListener#onMessage(Record) listener callback}.
- *
* {@link StreamMessageListenerContainer} tasks propagate errors during stream reads and
* {@link StreamListener#onMessage(Record) listener notification} to a configurable {@link ErrorHandler}. Errors stop a
* {@link Subscription} by default. Configuring a {@link Predicate} for a {@link StreamReadRequest} allows conditional
* subscription cancelling or continuing on all errors.
- *
* See the following example code how to use {@link StreamMessageListenerContainer}:
*
*
+ * Errors during {@link Record} retrieval lead to {@link Subscription#cancel() cancellation} of the underlying task.
+ *
* On {@link StreamMessageListenerContainer#stop()} all {@link Subscription subscriptions} are cancelled prior to
* shutting down the container itself.
*
@@ -178,13 +177,13 @@ public interface StreamMessageListenerContainer
* Every message must be acknowledged using
* {@link org.springframework.data.redis.core.StreamOperations#acknowledge(Object, String, String...)} after
* processing.
- *
* Errors during {@link Record} retrieval lead to {@link Subscription#cancel() cancellation} of the underlying task.
- *
* On {@link StreamMessageListenerContainer#stop()} all {@link Subscription subscriptions} are cancelled prior to
* shutting down the container itself.
*
@@ -204,11 +203,11 @@ public interface StreamMessageListenerContainer
* Every message is acknowledged when received.
- *
* Errors during {@link Record} retrieval lead to {@link Subscription#cancel() cancellation} of the underlying task.
- *
* On {@link StreamMessageListenerContainer#stop()} all {@link Subscription subscriptions} are cancelled prior to
* shutting down the container itself.
*
@@ -227,13 +226,13 @@ public interface StreamMessageListenerContainer
* Errors during {@link Record} are tested against test {@link StreamReadRequest#getCancelSubscriptionOnError()
* cancellation predicate} whether to cancel the underlying task.
- *
* On {@link StreamMessageListenerContainer#stop()} all {@link Subscription subscriptions} are cancelled prior to
* shutting down the container itself.
- *
* Errors during {@link Record} retrieval are delegated to the given {@link StreamReadRequest#getErrorHandler()}.
*
* @param streamRequest must not be {@literal null}.
diff --git a/src/main/java/org/springframework/data/redis/stream/StreamReceiver.java b/src/main/java/org/springframework/data/redis/stream/StreamReceiver.java
index f893576d8..f37a7f07e 100644
--- a/src/main/java/org/springframework/data/redis/stream/StreamReceiver.java
+++ b/src/main/java/org/springframework/data/redis/stream/StreamReceiver.java
@@ -42,7 +42,7 @@ import org.springframework.util.Assert;
/**
* A receiver to consume Redis Streams using reactive infrastructure.
- *
* Once created, a {@link StreamReceiver} can subscribe to a Redis Stream and consume incoming {@link Record records}.
* Consider a {@link Flux} of {@link Record} infinite. Cancelling the {@link org.reactivestreams.Subscription}
* terminates eventually background polling. Records are converted using {@link SerializationPair key and value
@@ -84,7 +84,7 @@ import org.springframework.util.Assert;
* {@link StreamReceiver} propagates errors during stream reads and deserialization as terminal error signal by default.
* Configuring a {@link StreamReceiverOptions#getResumeFunction() resume function} allows conditional resumption by
* dropping the record or by propagating the error to terminate the subscription.
- *
* See the following example code how to use {@link StreamReceiver}:
*
*
* Every record must be acknowledged using
* {@link org.springframework.data.redis.connection.ReactiveStreamCommands#xAck(ByteBuffer, String, String...)}
*
@@ -158,7 +158,7 @@ public interface StreamReceiver
* Every record is acknowledged when received.
*
* @param consumer consumer group, must not be {@literal null}.
@@ -173,7 +173,7 @@ public interface StreamReceiver
* Every record must be acknowledged using
* {@link org.springframework.data.redis.core.ReactiveStreamOperations#acknowledge(Object, String, String...)} after
* processing.
diff --git a/src/main/java/org/springframework/data/redis/stream/Subscription.java b/src/main/java/org/springframework/data/redis/stream/Subscription.java
index 8ab143ae4..ff6b28c25 100644
--- a/src/main/java/org/springframework/data/redis/stream/Subscription.java
+++ b/src/main/java/org/springframework/data/redis/stream/Subscription.java
@@ -19,10 +19,9 @@ import java.time.Duration;
/**
* The {@link Subscription} is the link to the actual running {@link Task}.
- *
* Due to the asynchronous nature of the {@link Task} execution a {@link Subscription} might not immediately become
* active. {@link #isActive()} provides an answer if the underlying {@link Task} is already running.
- *
* Blocks connection until element available or {@code timeout} reached.
*
* @param destination must not be {@literal null}.
@@ -127,7 +127,7 @@ public interface RedisList
* Blocks connection until element available or {@code timeout} reached.
*
* @param destination must not be {@literal null}.
@@ -161,7 +161,7 @@ public interface RedisList
* Blocks connection until element available or {@code timeout} reached.
*
* @param destination must not be {@literal null}.
@@ -186,7 +186,7 @@ public interface RedisList
* Blocks connection until element available or {@code timeout} reached.
*
* @param destination must not be {@literal null}.
diff --git a/src/main/java/org/springframework/data/redis/support/collections/RedisProperties.java b/src/main/java/org/springframework/data/redis/support/collections/RedisProperties.java
index 04614026b..5ef6eac63 100644
--- a/src/main/java/org/springframework/data/redis/support/collections/RedisProperties.java
+++ b/src/main/java/org/springframework/data/redis/support/collections/RedisProperties.java
@@ -38,7 +38,7 @@ import org.springframework.lang.Nullable;
* {@link Properties} extension for a Redis back-store. Useful for reading (and storing) properties inside a Redis hash.
* Particularly useful inside a Spring container for hooking into Spring's property placeholder or
* {@link org.springframework.beans.factory.config.PropertiesFactoryBean}.
- *
* Note that this implementation only accepts Strings - objects of other type are not supported.
*
* @see Properties
diff --git a/src/main/java/org/springframework/data/redis/support/collections/RedisZSet.java b/src/main/java/org/springframework/data/redis/support/collections/RedisZSet.java
index eaa430b2f..cb82b976e 100644
--- a/src/main/java/org/springframework/data/redis/support/collections/RedisZSet.java
+++ b/src/main/java/org/springframework/data/redis/support/collections/RedisZSet.java
@@ -33,7 +33,7 @@ import org.springframework.data.redis.core.ZSetOperations.TypedTuple;
/**
* Redis ZSet (or sorted set (by weight)). Acts as a {@link SortedSet} based on the given priorities or weights
* associated with each item.
- *
* Since using a {@link Comparator} does not apply, a ZSet implements the {@link SortedSet} methods where applicable.
*
* @author Costin Leau
diff --git a/src/main/java/org/springframework/data/redis/support/collections/package-info.java b/src/main/java/org/springframework/data/redis/support/collections/package-info.java
index deb156ae5..35440023c 100644
--- a/src/main/java/org/springframework/data/redis/support/collections/package-info.java
+++ b/src/main/java/org/springframework/data/redis/support/collections/package-info.java
@@ -1,9 +1,9 @@
/**
* Package providing implementations for most of the {@code java.util} collections on top of Redis.
- *
* For indexed collections, such as {@link java.util.List}, {@link java.util.Queue} or {@link java.util.Deque} consider
* {@link org.springframework.data.redis.support.collections.RedisList}.
- *
* For collections without duplicates the obvious candidate is
* {@link org.springframework.data.redis.support.collections.RedisSet}. Use
* {@link org.springframework.data.redis.support.collections.RedisZSet} if a certain order is required.
diff --git a/src/main/java/org/springframework/data/redis/support/package-info.java b/src/main/java/org/springframework/data/redis/support/package-info.java
deleted file mode 100644
index 3f3f0541e..000000000
--- a/src/main/java/org/springframework/data/redis/support/package-info.java
+++ /dev/null
@@ -1,6 +0,0 @@
-/**
- * Classes supporting the Redis packages, such as collection or atomic counters.
- */
-@org.springframework.lang.NonNullApi
-@org.springframework.lang.NonNullFields
-package org.springframework.data.redis.support;
diff --git a/src/main/java/org/springframework/data/redis/util/ByteUtils.java b/src/main/java/org/springframework/data/redis/util/ByteUtils.java
index 200eba577..75737a186 100644
--- a/src/main/java/org/springframework/data/redis/util/ByteUtils.java
+++ b/src/main/java/org/springframework/data/redis/util/ByteUtils.java
@@ -38,7 +38,7 @@ public final class ByteUtils {
/**
* Concatenate the given {@code byte} arrays into one, with overlapping array elements included twice.
- *
* The order of elements in the original arrays is preserved.
*
* @param array1 the first array.
@@ -56,7 +56,7 @@ public final class ByteUtils {
/**
* Concatenate the given {@code byte} arrays into one, with overlapping array elements included twice. Returns a new,
* empty array if {@code arrays} was empty and returns the first array if {@code arrays} contains only a single array.
- *
* The order of elements in the original arrays is preserved.
*
* @param arrays the arrays.
diff --git a/src/test/java/org/springframework/data/redis/ConnectionFactoryTracker.java b/src/test/java/org/springframework/data/redis/ConnectionFactoryTracker.java
index b14df5fc7..d7f9acb0e 100644
--- a/src/test/java/org/springframework/data/redis/ConnectionFactoryTracker.java
+++ b/src/test/java/org/springframework/data/redis/ConnectionFactoryTracker.java
@@ -25,7 +25,7 @@ import org.springframework.data.redis.connection.RedisConnectionFactory;
/**
* Basic utility to help with the destruction of {@link RedisConnectionFactory} inside JUnit 4 tests. Simply add the
- * factory during setup and then call {@link #cleanUp()} through the @AfterClass method.
+ * factory during setup and then call {@link #cleanUp()} through the {@code @AfterClass} method.
*
* @author Costin Leau
* @author Mark Paluch
diff --git a/src/test/java/org/springframework/data/redis/test/condition/EnabledOnCommand.java b/src/test/java/org/springframework/data/redis/test/condition/EnabledOnCommand.java
index ca114168e..85919d5db 100644
--- a/src/test/java/org/springframework/data/redis/test/condition/EnabledOnCommand.java
+++ b/src/test/java/org/springframework/data/redis/test/condition/EnabledOnCommand.java
@@ -27,7 +27,7 @@ import org.junit.jupiter.api.extension.ExtendWith;
/**
* {@code @EnabledOnCommand} is used to signal that the annotated test class or test method is only enabled if
* the specified command is available.
- *
* When applied at the class level, all test methods within that class will be enabled.
*
* @author Mark Paluch
diff --git a/src/test/java/org/springframework/data/redis/test/condition/EnabledOnRedisAvailable.java b/src/test/java/org/springframework/data/redis/test/condition/EnabledOnRedisAvailable.java
index face4e012..6d69fef31 100644
--- a/src/test/java/org/springframework/data/redis/test/condition/EnabledOnRedisAvailable.java
+++ b/src/test/java/org/springframework/data/redis/test/condition/EnabledOnRedisAvailable.java
@@ -27,7 +27,7 @@ import org.junit.jupiter.api.extension.ExtendWith;
/**
* {@code @EnabledOnRedisAvailable} is used to signal that the annotated test class or test method is only
* enabled if Redis is running at {@link #value() port}.
- *
* When applied at the class level, all test methods within that class will be enabled.
*
* @author Mark Paluch
diff --git a/src/test/java/org/springframework/data/redis/test/condition/EnabledOnRedisClusterAvailable.java b/src/test/java/org/springframework/data/redis/test/condition/EnabledOnRedisClusterAvailable.java
index f39ea616e..301b6d156 100644
--- a/src/test/java/org/springframework/data/redis/test/condition/EnabledOnRedisClusterAvailable.java
+++ b/src/test/java/org/springframework/data/redis/test/condition/EnabledOnRedisClusterAvailable.java
@@ -27,7 +27,7 @@ import org.junit.jupiter.api.extension.ExtendWith;
/**
* {@code @EnabledOnRedisClusterAvailable} is used to signal that the annotated test class or test method is only
* enabled if Redis Cluster is running.
- *
* When applied at the class level, all test methods within that class will be enabled.
*
* @author Mark Paluch
diff --git a/src/test/java/org/springframework/data/redis/test/condition/EnabledOnRedisSentinelAvailable.java b/src/test/java/org/springframework/data/redis/test/condition/EnabledOnRedisSentinelAvailable.java
index da62eeb03..eb814aab0 100644
--- a/src/test/java/org/springframework/data/redis/test/condition/EnabledOnRedisSentinelAvailable.java
+++ b/src/test/java/org/springframework/data/redis/test/condition/EnabledOnRedisSentinelAvailable.java
@@ -27,7 +27,7 @@ import org.junit.jupiter.api.extension.ExtendWith;
/**
* {@code @EnabledOnRedisSentinelAvailable} is used to signal that the annotated test class or test method is only
* enabled if Redis Sentinel is running.
- *
* When applied at the class level, all test methods within that class will be enabled.
*
* @author Mark Paluch
diff --git a/src/test/java/org/springframework/data/redis/test/condition/EnabledOnRedisVersion.java b/src/test/java/org/springframework/data/redis/test/condition/EnabledOnRedisVersion.java
index a5eca819c..f33456757 100644
--- a/src/test/java/org/springframework/data/redis/test/condition/EnabledOnRedisVersion.java
+++ b/src/test/java/org/springframework/data/redis/test/condition/EnabledOnRedisVersion.java
@@ -27,7 +27,7 @@ import org.junit.jupiter.api.extension.ExtendWith;
/**
* {@code @EnabledOnRedisVersion} is used to signal that the annotated test class or test method is only
* enabled if Redis has at least the specified {@link #value() version number}.
- *
* When applied at the class level, all test methods within that class will be enabled.
*
* @author Mark Paluch
+ *
*
* @param clusterNodes must not be {@literal null}.
*/
diff --git a/src/main/java/org/springframework/data/redis/connection/RedisListCommands.java b/src/main/java/org/springframework/data/redis/connection/RedisListCommands.java
index 055baec3b..992c168ad 100644
--- a/src/main/java/org/springframework/data/redis/connection/RedisListCommands.java
+++ b/src/main/java/org/springframework/data/redis/connection/RedisListCommands.java
@@ -218,7 +218,7 @@ public interface RedisListCommands {
* Atomically returns and removes the first/last element (head/tail depending on the {@code from} argument) of the
* list stored at {@code sourceKey}, and pushes the element at the first/last element (head/tail depending on the
* {@code to} argument) of the list stored at {@code destinationKey}.
- *
+ *
* sentinelHostAndPorts[0] = 127.0.0.1:23679 sentinelHostAndPorts[1] = 127.0.0.1:23680 ...
- *
- *
+ *
*
* @param sentinelHostAndPorts must not be {@literal null}.
* @since 1.5
diff --git a/src/main/java/org/springframework/data/redis/connection/RedisServerCommands.java b/src/main/java/org/springframework/data/redis/connection/RedisServerCommands.java
index 83b2378cb..3d3af6ac7 100644
--- a/src/main/java/org/springframework/data/redis/connection/RedisServerCommands.java
+++ b/src/main/java/org/springframework/data/redis/connection/RedisServerCommands.java
@@ -115,7 +115,6 @@ public interface RedisServerCommands {
*
- * If you prefer manual id assignment over server generated ones make sure to provide an id via
- * {@link Record#withId(RecordId)}.
+ * Append the given {@link MapRecord record} to the stream stored at {@code Record#getStream}. If you prefer manual id
+ * assignment over server generated ones make sure to provide an id via {@code Record#withId}.
*
* @param record the {@link MapRecord record} to append.
* @return the {@link RecordId id} after save. {@literal null} when used in pipeline / transaction.
@@ -100,9 +99,8 @@ public interface RedisStreamCommands {
}
/**
- * Append the given {@link MapRecord record} to the stream stored at {@link Record#getStream()}.
- * If you prefer manual id assignment over server generated ones make sure to provide an id via
- * {@link Record#withId(RecordId)}.
+ * Append the given {@link MapRecord record} to the stream stored at {@code Record#getStream}. If you prefer manual id
+ * assignment over server generated ones make sure to provide an id via {@code Record#withId}.
*
* @param record the {@link MapRecord record} to append.
* @param options additional options (eg. {@literal MAXLEN}). Must not be {@literal null}, use
diff --git a/src/main/java/org/springframework/data/redis/connection/RedisStringCommands.java b/src/main/java/org/springframework/data/redis/connection/RedisStringCommands.java
index febb10387..0d42bbf51 100644
--- a/src/main/java/org/springframework/data/redis/connection/RedisStringCommands.java
+++ b/src/main/java/org/springframework/data/redis/connection/RedisStringCommands.java
@@ -59,7 +59,7 @@ public interface RedisStringCommands {
/**
* Return the value at {@code key} and expire the key by applying {@link Expiration}.
- *
* Use {@link Expiration#milliseconds(long)} for {@code PX}.
* Use {@link Expiration#unixTimestamp(long, TimeUnit)} for {@code EXAT | PXAT}.
@@ -385,29 +385,21 @@ public interface RedisStringCommands {
/**
* Do not set any additional command argument.
- *
- * @return
*/
UPSERT,
/**
* {@code NX}
- *
- * @return
*/
SET_IF_ABSENT,
/**
* {@code XX}
- *
- * @return
*/
SET_IF_PRESENT;
/**
* Do not set any additional command argument.
- *
- * @return
*/
public static SetOption upsert() {
return UPSERT;
@@ -415,8 +407,6 @@ public interface RedisStringCommands {
/**
* {@code XX}
- *
- * @return
*/
public static SetOption ifPresent() {
return SET_IF_PRESENT;
@@ -424,8 +414,6 @@ public interface RedisStringCommands {
/**
* {@code NX}
- *
- * @return
*/
public static SetOption ifAbsent() {
return SET_IF_ABSENT;
diff --git a/src/main/java/org/springframework/data/redis/connection/RedisTxCommands.java b/src/main/java/org/springframework/data/redis/connection/RedisTxCommands.java
index dfcdb38d7..edc745c20 100644
--- a/src/main/java/org/springframework/data/redis/connection/RedisTxCommands.java
+++ b/src/main/java/org/springframework/data/redis/connection/RedisTxCommands.java
@@ -29,7 +29,6 @@ public interface RedisTxCommands {
/**
* Mark the start of a transaction block.
* Commands will be queued and can then be executed by calling {@link #exec()} or rolled back using {@link #discard()}
- *
*
- *
*
* @author Mark Paluch
* @author Christoph Strobl
@@ -152,7 +151,7 @@ public interface JedisClientConfiguration {
/**
* Enable connection-pooling.
- *
+ *
+ *
*
* @param callback provides the to retrieve entity ids. Must not be {@literal null}.
* @param type must not be {@literal null}.
diff --git a/src/main/java/org/springframework/data/redis/core/RedisOperations.java b/src/main/java/org/springframework/data/redis/core/RedisOperations.java
index fa03490f5..4c0fd9827 100644
--- a/src/main/java/org/springframework/data/redis/core/RedisOperations.java
+++ b/src/main/java/org/springframework/data/redis/core/RedisOperations.java
@@ -58,7 +58,7 @@ public interface RedisOperations
* Commands will be queued and can then be executed by calling {@link #exec()} or rolled back using {@link #discard()}
- * Example
*
*
diff --git a/src/main/java/org/springframework/data/redis/hash/ObjectHashMapper.java b/src/main/java/org/springframework/data/redis/hash/ObjectHashMapper.java
index 5b0837df7..72a281230 100644
--- a/src/main/java/org/springframework/data/redis/hash/ObjectHashMapper.java
+++ b/src/main/java/org/springframework/data/redis/hash/ObjectHashMapper.java
@@ -123,7 +123,7 @@ public class ObjectHashMapper implements HashMapper
@@ -158,10 +158,9 @@ public interface StreamMessageListenerContainer
@@ -144,7 +144,7 @@ public interface StreamReceiver