Polishing.

Author: mp911de

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

@@ -71,7 +71,6 @@
  * @author Andrey Shlykov
  * @author ihaohong
  * @author Shyngys Sapraliyev
- *
  * @see RedisCallback
  * @see RedisSerializer
  * @see StringRedisTemplate
@@ -1661,7 +1660,6 @@ default Long lPos(String key, String element) {
 	 */
 	Long zRemRange(String key, long start, long end);
 
-
 	/**
 	 * Remove all elements between the lexicographical {@link Range}.
 	 *
@@ -1941,7 +1939,8 @@ default Set<StringTuple> zUnionWithScores(Aggregate aggregate, int[] weights, St
 	 * @return
 	 * @since 1.6
 	 * @see <a href="https://redis.io/commands/zrangebylex">Redis Documentation: ZRANGEBYLEX</a>
-	 * @see RedisZSetCommands#zRangeByLex(byte[], org.springframework.data.domain.Range, org.springframework.data.redis.connection.Limit)
+	 * @see RedisZSetCommands#zRangeByLex(byte[], org.springframework.data.domain.Range,
+	 *      org.springframework.data.redis.connection.Limit)
 	 */
 	Set<String> zRangeByLex(String key, org.springframework.data.domain.Range<String> range,
 			org.springframework.data.redis.connection.Limit limit);
@@ -1983,7 +1982,8 @@ default Set<String> zRevRangeByLex(String key, org.springframework.data.domain.R
 	 * @return
 	 * @since 2.4
 	 * @see <a href="https://redis.io/commands/zrevrangebylex">Redis Documentation: ZREVRANGEBYLEX</a>
-	 * @see RedisZSetCommands#zRevRangeByLex(byte[], org.springframework.data.domain.Range, org.springframework.data.redis.connection.Limit)
+	 * @see RedisZSetCommands#zRevRangeByLex(byte[], org.springframework.data.domain.Range,
+	 *      org.springframework.data.redis.connection.Limit)
 	 */
 	Set<String> zRevRangeByLex(String key, org.springframework.data.domain.Range<String> range,
 			org.springframework.data.redis.connection.Limit limit);
@@ -2498,9 +2498,10 @@ List<Long> hpExpireAt(String key, long unixTimeInMillis, Hash.FieldExpirationOpt
 	 *
 	 * @param key must not be {@literal null}.
 	 * @param fields must not be {@literal null}.
-	 * @return a list of {@link Long} values for each of the fields provided: the time to live in milliseconds; or a negative value
-	 * 	       to signal an error. The command returns {@code -1} if the key exists but has no associated expiration time.
-	 * 	       The command returns {@code -2} if the key does not exist; {@literal null} when used in pipeline / transaction.
+	 * @return a list of {@link Long} values for each of the fields provided: the time to live in milliseconds; or a
+	 *         negative value to signal an error. The command returns {@code -1} if the key exists but has no associated
+	 *         expiration time. The command returns {@code -2} if the key does not exist; {@literal null} when used in
+	 *         pipeline / transaction.
 	 * @see <a href="https://redis.io/docs/latest/commands/hexpire/">Redis Documentation: HTTL</a>
 	 * @since 3.5
 	 */
@@ -2513,9 +2514,10 @@ List<Long> hpExpireAt(String key, long unixTimeInMillis, Hash.FieldExpirationOpt
 	 * @param key must not be {@literal null}.
 	 * @param timeUnit must not be {@literal null}.
 	 * @param fields must not be {@literal null}.
-	 * @return a list of {@link Long} values for each of the fields provided: the time to live in the {@link TimeUnit} provided; or a negative value
-	 *         to signal an error. The command returns {@code -1} if the key exists but has no associated expiration time.
-	 * 	       The command returns {@code -2} if the key does not exist; {@literal null} when used in pipeline / transaction.
+	 * @return a list of {@link Long} values for each of the fields provided: the time to live in the {@link TimeUnit}
+	 *         provided; or a negative value to signal an error. The command returns {@code -1} if the key exists but has
+	 *         no associated expiration time. The command returns {@code -2} if the key does not exist; {@literal null}
+	 *         when used in pipeline / transaction.
 	 * @see <a href="https://redis.io/docs/latest/commands/hexpire/">Redis Documentation: HTTL</a>
 	 * @since 3.5
 	 */
@@ -2527,9 +2529,10 @@ List<Long> hpExpireAt(String key, long unixTimeInMillis, Hash.FieldExpirationOpt
 	 *
 	 * @param key must not be {@literal null}.
 	 * @param fields must not be {@literal null}.
-	 * @return a list of {@link Long} values for each of the fields provided: the time to live in milliseconds; or a negative value
-	 * 	       to signal an error. The command returns {@code -1} if the key exists but has no associated expiration time.
-	 * 	       The command returns {@code -2} if the key does not exist; {@literal null} when used in pipeline / transaction.
+	 * @return a list of {@link Long} values for each of the fields provided: the time to live in milliseconds; or a
+	 *         negative value to signal an error. The command returns {@code -1} if the key exists but has no associated
+	 *         expiration time. The command returns {@code -2} if the key does not exist; {@literal null} when used in
+	 *         pipeline / transaction.
 	 * @see <a href="https://redis.io/docs/latest/commands/hexpire/">Redis Documentation: HTTL</a>
 	 * @since 3.5
 	 */
@@ -2759,8 +2762,7 @@ GeoResults<GeoLocation<String>> geoRadiusByMember(String key, String member, Dis
 
 	/**
 	 * Return the members of a geo set which are within the borders of the area specified by a given {@link GeoShape
-	 * shape}. The query's center point is provided by
-	 * {@link GeoReference}.
+	 * shape}. The query's center point is provided by {@link GeoReference}.
 	 *
 	 * @param key must not be {@literal null}.
 	 * @param reference must not be {@literal null}.
@@ -2776,8 +2778,7 @@ GeoResults<GeoLocation<String>> geoSearch(String key, GeoReference<String> refer
 
 	/**
 	 * Query the members of a geo set which are within the borders of the area specified by a given {@link GeoShape shape}
-	 * and store the result at {@code destKey}. The query's center point is provided by
-	 * {@link GeoReference}.
+	 * and store the result at {@code destKey}. The query's center point is provided by {@link GeoReference}.
 	 *
 	 * @param key must not be {@literal null}.
 	 * @param reference must not be {@literal null}.

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

@@ -25,6 +25,7 @@
 
 import org.springframework.data.redis.connection.Hash.FieldExpirationOptions;
 import org.springframework.data.redis.core.types.Expiration;
+import org.springframework.data.redis.core.types.Expirations;
 import org.springframework.lang.Nullable;
 
 /**

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

@@ -29,8 +29,9 @@
 import org.springframework.core.convert.converter.Converter;
 import org.springframework.data.redis.connection.Hash.FieldExpirationOptions;
 import org.springframework.data.redis.connection.convert.Converters;
-import org.springframework.data.redis.core.Expirations.Timeouts;
 import org.springframework.data.redis.core.types.Expiration;
+import org.springframework.data.redis.core.types.Expirations;
+import org.springframework.data.redis.core.types.Expirations.Timeouts;
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 

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

@@ -36,8 +36,9 @@
 import org.springframework.data.redis.connection.ReactiveHashCommands.ExpireCommand;
 import org.springframework.data.redis.connection.ReactiveRedisConnection.NumericResponse;
 import org.springframework.data.redis.connection.convert.Converters;
-import org.springframework.data.redis.core.Expirations.Timeouts;
 import org.springframework.data.redis.core.types.Expiration;
+import org.springframework.data.redis.core.types.Expirations;
+import org.springframework.data.redis.core.types.Expirations.Timeouts;
 import org.springframework.data.redis.serializer.RedisSerializationContext;
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;

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

@@ -25,6 +25,7 @@
 
 import org.springframework.data.redis.connection.Hash.FieldExpirationOptions;
 import org.springframework.data.redis.core.types.Expiration;
+import org.springframework.data.redis.core.types.Expirations;
 import org.springframework.lang.Nullable;
 
 /**

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

@@ -28,6 +28,7 @@
 
 import org.springframework.data.redis.connection.Hash.FieldExpirationOptions;
 import org.springframework.data.redis.core.types.Expiration;
+import org.springframework.data.redis.core.types.Expirations;
 import org.springframework.lang.Nullable;
 
 /**

src/main/java/org/springframework/data/redis/core/Expirations.java renamed to src/main/java/org/springframework/data/redis/core/types/Expirations.java

@@ -13,12 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.springframework.data.redis.core;
+package org.springframework.data.redis.core.types;
 
 import java.time.Duration;
+import java.util.Collection;
 import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.NoSuchElementException;
 import java.util.Objects;
 import java.util.Set;
 import java.util.concurrent.TimeUnit;
@@ -39,9 +41,10 @@
  * </ol>
  *
  * @author Christoph Strobl
+ * @author Mark Paluch
  * @since 3.5
  */
-public class Expirations<K> { // TODO: should we move this to let's say Hash.class or another place
+public class Expirations<K> {
 
 	private final TimeUnit unit;
 	private final Map<K, TimeToLive> expirations;
@@ -87,15 +90,15 @@ public Set<K> persistent() {
 	}
 
 	/**
-	 * @return an ordered set of keys that do not exists and therefore do not have a time to live.
+	 * @return an ordered set of keys that do not exist and therefore do not have a time to live.
 	 */
 	public Set<K> missing() {
 		return filterByState(TimeToLive.MISSING);
 	}
 
 	/**
 	 * @return an ordered set of all {@link Expirations expirations} where the {@link TimeToLive#value()} is using the
-	 *         {@link TimeUnit} defined in {@link #precision()}.
+	 *         {@link TimeUnit} defined in {@link #timeUnit()}.
 	 */
 	public List<TimeToLive> ttl() {
 		return expirations.values().stream().map(it -> it.convert(this.unit)).toList();
@@ -104,7 +107,7 @@ public List<TimeToLive> ttl() {
 	/**
 	 * @return the {@link TimeUnit} for {@link TimeToLive expirations} held by this instance.
 	 */
-	public TimeUnit precision() {
+	public TimeUnit timeUnit() {
 		return unit;
 	}
 
@@ -114,21 +117,30 @@ public TimeUnit precision() {
 	 *         skipped.
 	 */
 	public List<Map.Entry<K, Duration>> expiring() {
+
 		return expirations.entrySet().stream().filter(it -> !it.getValue().isMissing() && !it.getValue().isPersistent())
 				.map(it -> Map.entry(it.getKey(), toDuration(it.getValue()))).toList();
 	}
 
+	/**
+	 * @return the ordered collection of keys that are associated with an expiration.
+	 */
+	public Collection<K> keys() {
+		return expirations.keySet();
+	}
+
 	/**
 	 * @param key
 	 * @return the {@link Expirations expirations} where the {@link TimeToLive#value()} is using the {@link TimeUnit}
-	 *         defined in {@link #precision()} or {@literal null} if no entry could be found.
+	 *         defined in {@link #timeUnit()} or {@literal null} if no entry could be found.
+	 * @throws NoSuchElementException if no expiration found for the given key.
 	 */
-	@Nullable
 	public TimeToLive expirationOf(K key) {
 
 		TimeToLive timeToLive = expirations.get(key);
+
 		if (timeToLive == null) {
-			return null;
+			throw new NoSuchElementException("No expiration found for key '%s'".formatted(key));
 		}
 
 		return timeToLive.convert(this.unit);
@@ -142,12 +154,7 @@ public TimeToLive expirationOf(K key) {
 	 */
 	@Nullable
 	public Duration ttlOf(K key) {
-
-		TimeToLive timeToLive = expirationOf(key);
-		if (timeToLive == null) {
-			return null;
-		}
-		return toDuration(timeToLive);
+		return toDuration(expirationOf(key));
 	}
 
 	private Set<K> filterByState(TimeToLive filter) {
@@ -161,6 +168,7 @@ static Duration toDuration(TimeToLive timeToLive) {
 		if (timeToLive.sourceUnit == null) {
 			return null;
 		}
+
 		return Duration.of(timeToLive.raw(), timeToLive.sourceUnit.toChronoUnit());
 	}
 
@@ -173,6 +181,7 @@ Long get(int index) {
 		public int size() {
 			return raw.size();
 		}
+
 	}
 
 	/**
@@ -182,10 +191,10 @@ public int size() {
 	 * {@link #PERSISTENT} mark predefined states returned by Redis indicating a time to live value could not be retrieved
 	 * due to various reasons.
 	 */
-	public static class TimeToLive { // TODO: is Expiry a better name for this type?
+	public static class TimeToLive {
 
 		/**
-		 * Predefined {@link TimeToLive} for a key that does not exists and therefore does not have a time to live.
+		 * Predefined {@link TimeToLive} for a key that does not exist and therefore does not have a time to live.
 		 */
 		public static TimeToLive MISSING = new TimeToLive(-2L);
 
@@ -194,9 +203,10 @@ public static class TimeToLive { // TODO: is Expiry a better name for this type?
 		 */
 		public static TimeToLive PERSISTENT = new TimeToLive(-1L);
 
+		final @Nullable TimeUnit sourceUnit;
+		final @Nullable TimeUnit targetUnit;
+
 		private final long raw;
-		@Nullable TimeUnit sourceUnit;
-		@Nullable TimeUnit targetUnit;
 
 		public TimeToLive(long value) {
 			this(value, null);
@@ -301,5 +311,7 @@ public boolean equals(Object o) {
 		public int hashCode() {
 			return Objects.hash(raw);
 		}
+
 	}
+
 }

src/main/java/org/springframework/data/redis/support/collections/DefaultRedisMap.java

@@ -27,11 +27,11 @@
 import org.springframework.data.redis.connection.DataType;
 import org.springframework.data.redis.core.BoundHashOperations;
 import org.springframework.data.redis.core.Cursor;
-import org.springframework.data.redis.core.Expirations;
 import org.springframework.data.redis.core.ExpireChanges;
 import org.springframework.data.redis.core.RedisOperations;
 import org.springframework.data.redis.core.ScanOptions;
 import org.springframework.data.redis.core.SessionCallback;
+import org.springframework.data.redis.core.types.Expirations;
 import org.springframework.lang.Nullable;
 
 /**

src/main/java/org/springframework/data/redis/support/collections/RedisMap.java

@@ -23,8 +23,8 @@
 import java.util.concurrent.ConcurrentMap;
 import java.util.concurrent.TimeUnit;
 
-import org.springframework.data.redis.core.Expirations;
 import org.springframework.data.redis.core.ExpireChanges;
+import org.springframework.data.redis.core.types.Expirations;
 import org.springframework.lang.Nullable;
 
 /**

src/main/java/org/springframework/data/redis/support/collections/RedisProperties.java

@@ -33,9 +33,9 @@
 
 import org.springframework.data.redis.connection.DataType;
 import org.springframework.data.redis.core.BoundHashOperations;
-import org.springframework.data.redis.core.Expirations;
 import org.springframework.data.redis.core.ExpireChanges;
 import org.springframework.data.redis.core.RedisOperations;
+import org.springframework.data.redis.core.types.Expirations;
 import org.springframework.lang.Nullable;
 
 /**

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

@@ -36,8 +36,8 @@
 import org.springframework.data.redis.connection.Hash.FieldExpirationOptions;
 import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
 import org.springframework.data.redis.connection.jedis.extension.JedisConnectionFactoryExtension;
-import org.springframework.data.redis.core.Expirations.TimeToLive;
 import org.springframework.data.redis.core.ExpireChanges.ExpiryChangeState;
+import org.springframework.data.redis.core.types.Expirations.TimeToLive;
 import org.springframework.data.redis.test.condition.EnabledOnCommand;
 import org.springframework.data.redis.test.extension.RedisStanalone;
 import org.springframework.data.redis.test.extension.parametrized.MethodSource;
@@ -230,7 +230,7 @@ void testExpireAndGetExpireMillis() {
 		assertThat(redisTemplate.opsForHash().getTimeToLive(key, List.of(key1))).satisfies(expirations -> {
 
 			assertThat(expirations.missing()).isEmpty();
-			assertThat(expirations.precision()).isEqualTo(TimeUnit.SECONDS);
+			assertThat(expirations.timeUnit()).isEqualTo(TimeUnit.SECONDS);
 			assertThat(expirations.expirationOf(key1)).extracting(TimeToLive::raw, InstanceOfAssertFactories.LONG)
 					.isBetween(0L, 1L);
 			assertThat(expirations.ttlOf(key1)).isBetween(Duration.ZERO, Duration.ofSeconds(1));
@@ -261,7 +261,7 @@ void testExpireAndGetExpireSeconds() {
 		assertThat(redisTemplate.opsForHash().getTimeToLive(key, TimeUnit.SECONDS, List.of(key1, key2)))
 				.satisfies(expirations -> {
 					assertThat(expirations.missing()).isEmpty();
-					assertThat(expirations.precision()).isEqualTo(TimeUnit.SECONDS);
+					assertThat(expirations.timeUnit()).isEqualTo(TimeUnit.SECONDS);
 					assertThat(expirations.expirationOf(key1)).extracting(TimeToLive::raw, InstanceOfAssertFactories.LONG)
 							.isBetween(0L, 5L);
 					assertThat(expirations.ttlOf(key1)).isBetween(Duration.ofSeconds(1), Duration.ofSeconds(5));
@@ -286,7 +286,7 @@ void testExpireAtAndGetExpireMillis() {
 		assertThat(redisTemplate.opsForHash().getTimeToLive(key, TimeUnit.MILLISECONDS, List.of(key1, key2)))
 				.satisfies(expirations -> {
 					assertThat(expirations.missing()).isEmpty();
-					assertThat(expirations.precision()).isEqualTo(TimeUnit.MILLISECONDS);
+					assertThat(expirations.timeUnit()).isEqualTo(TimeUnit.MILLISECONDS);
 					assertThat(expirations.expirationOf(key1)).extracting(TimeToLive::raw, InstanceOfAssertFactories.LONG)
 							.isBetween(0L, 500L);
 					assertThat(expirations.ttlOf(key1)).isBetween(Duration.ZERO, Duration.ofMillis(500));