DATAREDIS-611 - Update Javadoc and remove superfluous negativity limitations.

Original Pull Request: spring-projects#501

Author: christophstrobl

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

@@ -64,14 +64,15 @@ public interface BoundKeyOperations<K> {
  * Sets the key time-to-live/expiration.
  *
  * @param timeout must not be {@literal null}.
- * @return true if expiration was set, false otherwise. {@literal null} when used in pipeline / transaction.
+ * @return {@literal true} if expiration was set, {@literal false} otherwise. {@literal null} when used in pipeline /
+ * transaction.
+ * @throws IllegalArgumentException if the timeout is {@literal null}.
  * @since 2.3
  */
 @Nullable
 default Boolean expire(Duration timeout) {
 
 Assert.notNull(timeout, "Timeout must not be null");
-Assert.isTrue(!timeout.isNegative(), "Timeout must not be negative");
 
 return expire(timeout.toMillis(), TimeUnit.MILLISECONDS);
 }
@@ -98,14 +99,16 @@ default Boolean expire(Duration timeout) {
 /**
  * Sets the key time-to-live/expiration.
  *
- * @param time expiration time.
- * @return true if expiration was set, false otherwise. {@literal null} when used in pipeline / transaction.
+ * @param expireAt expiration time.
+ * @return {@literal true} if expiration was set, {@literal false} otherwise. {@literal null} when used in pipeline /
+ * transaction.
+ * @throws IllegalArgumentException if the instant is {@literal null} or too large to represent as a {@code Date}.
  * @since 2.3
  */
 @Nullable
 default Boolean expireAt(Instant expireAt) {
 
-Assert.notNull(expireAt, "Timestamp must not be null");
+Assert.notNull(expireAt, "ExpireAt must not be null");
 
 return expireAt(Date.from(expireAt));
 }

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

@@ -196,6 +196,7 @@ public interface BoundListOperations<K, V> extends BoundKeyOperations<K> {
  *
  * @param timeout must not be {@literal null}.
  * @return {@literal null} when timeout reached or used in pipeline / transaction.
+ * @throws IllegalArgumentException if the timeout is {@literal null} or negative.
  * @since 2.3
  * @see <a href="https://redis.io/commands/blpop">Redis Documentation: BLPOP</a>
  */
@@ -235,6 +236,7 @@ default V leftPop(Duration timeout) {
  *
  * @param timeout must not be {@literal null}.
  * @return {@literal null} when timeout reached or used in pipeline / transaction.
+ * @throws IllegalArgumentException if the timeout is {@literal null} or negative.
  * @since 2.3
  * @see <a href="https://redis.io/commands/brpop">Redis Documentation: BRPOP</a>
  */

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

@@ -243,6 +243,7 @@ public interface ListOperations<K, V> {
  * @param key must not be {@literal null}.
  * @param timeout must not be {@literal null}.
  * @return can be {@literal null}.
+ * @throws IllegalArgumentException if the timeout is {@literal null} or negative.
  * @since 2.3
  * @see <a href="https://redis.io/commands/blpop">Redis Documentation: BLPOP</a>
  */
@@ -330,6 +331,7 @@ default V rightPop(K key, Duration timeout) {
  * @param destinationKey must not be {@literal null}.
  * @param timeout must not be {@literal null}.
  * @return can be {@literal null}.
+ * @throws IllegalArgumentException if the timeout is {@literal null} or negative.
  * @since 2.3
  * @see <a href="https://redis.io/commands/brpoplpush">Redis Documentation: BRPOPLPUSH</a>
  */

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

@@ -289,13 +289,13 @@ <T> T execute(RedisScript<T> script, RedisSerializer<?> argsSerializer, RedisSer
  * @param key must not be {@literal null}.
  * @param timeout must not be {@literal null}.
  * @return {@literal null} when used in pipeline / transaction.
+ * @throws IllegalArgumentException if the timeout is {@literal null}.
  * @since 2.3
  */
 @Nullable
 default Boolean expire(K key, Duration timeout) {
 
 Assert.notNull(timeout, "Timeout must not be null");
-Assert.isTrue(!timeout.isNegative(), "Timeout must not be negative");
 
 return TimeoutUtils.hasMillis(timeout) ? expire(key, timeout.toMillis(), TimeUnit.MILLISECONDS)
 : expire(key, timeout.getSeconds(), TimeUnit.SECONDS);
@@ -317,6 +317,7 @@ default Boolean expire(K key, Duration timeout) {
  * @param key must not be {@literal null}.
  * @param expireAt must not be {@literal null}.
  * @return {@literal null} when used in pipeline / transaction.
+ * @throws IllegalArgumentException if the instant is {@literal null} or too large to represent as a {@code Date}.
  * @since 2.3
  */
 @Nullable

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

@@ -131,8 +131,9 @@ public void testLeftPushAll() {
 assertThat(listOps.range(key, 0, -1)).contains(v3, v2, v1);
 }
 
-@Test
+@Test // DATAREDIS-611
 public void testLeftPopDuration() {
+
 // 1 ms timeout gets upgraded to 1 sec timeout at the moment
 assumeTrue(RedisTestProfileValueSource.matches("runLongTests", "true"));
 assumeTrue(valueFactory instanceof StringObjectFactory);
@@ -146,8 +147,9 @@ public void testLeftPopDuration() {
 assertThat(listOps.leftPop(key, Duration.ofSeconds(1))).isEqualTo(v1);
 }
 
-@Test
+@Test // DATAREDIS-611
 public void testRightPopDuration() {
+
 // 1 ms timeout gets upgraded to 1 sec timeout at the moment
 assumeTrue(RedisTestProfileValueSource.matches("runLongTests", "true"));
 assumeTrue(valueFactory instanceof StringObjectFactory);