Polish "Add HGETDEL, HGETEX and HSETEX hash commands".

This commit polishes the previous commit with the following: - Add missing `@Override` tag - Update javadoc to include details for returned values - Adds the `HSETEX` command to `LettuceCommand` Original Pull Request: #3226 Resolves: #3211 Signed-off-by: Chris Bono <chris.bono@broadcom.com>

Author: onobc

src/main/java/org/springframework/data/redis/connection/RedisHashCommands.java

@@ -551,7 +551,8 @@ default List<Long> hExpireAt(byte @NonNull [] key, long unixTime, byte @NonNull
  *
  * @param key must not be {@literal null}.
  * @param fields must not be {@literal null}.
- * @return empty {@link List} if key does not exist. {@literal null} when used in pipeline / transaction.
+ * @return list of values for deleted {@code fields} ({@literal null} for fields that does not exist) or an
+ * empty {@link List} if key does not exist or {@literal null} when used in pipeline / transaction.
  * @see <a href="https://redis.io/commands/hgetdel">Redis Documentation: HGETDEL</a>
  */
  List<byte[]> hGetDel(byte @NonNull [] key, byte @NonNull [] @NonNull... fields);
@@ -562,7 +563,8 @@ default List<Long> hExpireAt(byte @NonNull [] key, long unixTime, byte @NonNull
  *
  * @param key must not be {@literal null}.
  * @param fields must not be {@literal null}.
- * @return empty {@link List} if key does not exist. {@literal null} when used in pipeline / transaction.
+ * @return list of values for given {@code fields} or an empty {@link List} if key does not
+ * exist or {@literal null} when used in pipeline / transaction.
  * @see <a href="https://redis.io/commands/hgetex">Redis Documentation: HGETEX</a>
  */
  List<byte[]> hGetEx(byte @NonNull [] key, Expiration expiration,

src/main/java/org/springframework/data/redis/connection/jedis/JedisConverters.java

@@ -15,15 +15,22 @@
  */
 package org.springframework.data.redis.connection.jedis;
 
-import org.springframework.data.redis.connection.*;
 import redis.clients.jedis.GeoCoordinate;
 import redis.clients.jedis.HostAndPort;
 import redis.clients.jedis.Protocol;
 import redis.clients.jedis.args.BitOP;
 import redis.clients.jedis.args.FlushMode;
 import redis.clients.jedis.args.GeoUnit;
 import redis.clients.jedis.args.ListPosition;
-import redis.clients.jedis.params.*;
+import redis.clients.jedis.params.GeoRadiusParam;
+import redis.clients.jedis.params.GeoSearchParam;
+import redis.clients.jedis.params.GetExParams;
+import redis.clients.jedis.params.HGetExParams;
+import redis.clients.jedis.params.HSetExParams;
+import redis.clients.jedis.params.ScanParams;
+import redis.clients.jedis.params.SetParams;
+import redis.clients.jedis.params.SortingParams;
+import redis.clients.jedis.params.ZAddParams;
 import redis.clients.jedis.resps.GeoRadiusResponse;
 import redis.clients.jedis.util.SafeEncoder;
 
@@ -48,19 +55,27 @@
 import org.springframework.data.geo.Metric;
 import org.springframework.data.geo.Metrics;
 import org.springframework.data.geo.Point;
+import org.springframework.data.redis.connection.BitFieldSubCommands;
 import org.springframework.data.redis.connection.BitFieldSubCommands.BitFieldIncrBy;
 import org.springframework.data.redis.connection.BitFieldSubCommands.BitFieldSet;
 import org.springframework.data.redis.connection.BitFieldSubCommands.BitFieldSubCommand;
+import org.springframework.data.redis.connection.RedisGeoCommands;
 import org.springframework.data.redis.connection.RedisGeoCommands.DistanceUnit;
 import org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation;
 import org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs;
 import org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs.Flag;
+import org.springframework.data.redis.connection.RedisHashCommands;
 import org.springframework.data.redis.connection.RedisListCommands.Position;
+import org.springframework.data.redis.connection.RedisNode;
+import org.springframework.data.redis.connection.RedisServer;
+import org.springframework.data.redis.connection.RedisServerCommands;
 import org.springframework.data.redis.connection.RedisStringCommands.BitOperation;
 import org.springframework.data.redis.connection.RedisStringCommands.SetOption;
 import org.springframework.data.redis.connection.RedisZSetCommands.ZAddArgs;
+import org.springframework.data.redis.connection.SortParameters;
 import org.springframework.data.redis.connection.SortParameters.Order;
 import org.springframework.data.redis.connection.SortParameters.Range;
+import org.springframework.data.redis.connection.ValueEncoding;
 import org.springframework.data.redis.connection.convert.Converters;
 import org.springframework.data.redis.connection.convert.ListConverter;
 import org.springframework.data.redis.connection.convert.StringToRedisClientInfoConverter;

src/main/java/org/springframework/data/redis/connection/lettuce/LettuceConnection.java

@@ -1252,6 +1252,7 @@ static class TypeHints {
 COMMAND_OUTPUT_TYPE_MAPPING.put(EXPIREAT, BooleanOutput.class);
 COMMAND_OUTPUT_TYPE_MAPPING.put(HEXISTS, BooleanOutput.class);
 COMMAND_OUTPUT_TYPE_MAPPING.put(HSET, BooleanOutput.class);
+COMMAND_OUTPUT_TYPE_MAPPING.put(HSETEX, BooleanOutput.class);
 COMMAND_OUTPUT_TYPE_MAPPING.put(HSETNX, BooleanOutput.class);
 COMMAND_OUTPUT_TYPE_MAPPING.put(MOVE, BooleanOutput.class);
 COMMAND_OUTPUT_TYPE_MAPPING.put(COPY, BooleanOutput.class);

src/main/java/org/springframework/data/redis/connection/lettuce/LettuceHashCommands.java

@@ -287,6 +287,7 @@ public List<byte[]> hGetEx(byte @NonNull [] key, Expiration expiration, byte @No
  .toList(source -> source.getValueOrElse(null));
  }
 
+@Override
  public Boolean hSetEx(byte @NonNull [] key, @NonNull Map<byte[], byte[]> hashes, HashFieldSetOption condition,
  Expiration expiration) {
 

src/main/java/org/springframework/data/redis/core/HashOperations.java

@@ -87,7 +87,7 @@ public interface HashOperations<H, HK, HV> {
  *
  * @param key must not be {@literal null}.
  * @param hashKeys must not be {@literal null}.
- * @return {@literal null} when used in pipeline / transaction.
+ * @return list of values for the given fields or {@literal null} when used in pipeline / transaction.
  * @since 4.0
  */
  List<HV> getAndDelete(@NonNull H key, @NonNull Collection<@NonNull HK> hashKeys);
@@ -99,7 +99,7 @@ public interface HashOperations<H, HK, HV> {
  * @param key must not be {@literal null}.
  * @param expiration is optional.
  * @param hashKeys must not be {@literal null}.
- * @return {@literal null} when used in pipeline / transaction.
+ * @return list of values for the given fields or {@literal null} when used in pipeline / transaction.
  * @since 4.0
  */
  List<HV> getAndExpire(@NonNull H key, Expiration expiration, @NonNull Collection<@NonNull HK> hashKeys);
@@ -111,7 +111,7 @@ public interface HashOperations<H, HK, HV> {
  * @param m must not be {@literal null}.
  * @param condition is optional.
  * @param expiration is optional.
- * @return {@literal null} when used in pipeline / transaction.
+ * @return whether all fields were set or {@literal null} when used in pipeline / transaction.
  * @since 4.0
  */
  Boolean putAndExpire(@NonNull H key, @NonNull Map<? extends @NonNull HK, ? extends HV> m,

src/test/java/org/springframework/data/redis/core/DefaultHashOperationsIntegrationTests.java

@@ -21,7 +21,11 @@
 import java.io.IOException;
 import java.time.Duration;
 import java.time.Instant;
-import java.util.*;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
 import java.util.concurrent.TimeUnit;
 
 import org.assertj.core.api.InstanceOfAssertFactories;