Polishing.

Add leftPop/rightPop methods to BoundListOperations. Tweak Javadoc and add since tags. Extend tests.

Closes #1987

Author: mp911de

src/main/asciidoc/new-features.adoc

@@ -7,6 +7,7 @@ This section briefly covers items that are new and noteworthy in the latest rele
 == New in Spring Data Redis 2.6
 
 * Support for `SubscriptionListener` when using `MessageListener` for subscription confirmation callbacks. `ReactiveRedisMessageListenerContainer` and `ReactiveRedisOperations` provide `receiveLater(…)` and `listenToLater(…)` methods to await until Redis acknowledges the subscription.
+* Support Redis 6.2 commands (`LPOP`/`RPOP` with `count`).
 
 [[new-in-2.5.0]]
 == New in Spring Data Redis 2.5

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

@@ -922,6 +922,7 @@ public PopCommand from(ByteBuffer key) {
 		 *
 		 * @param count
 		 * @return a new {@link LSetCommand} with {@literal value} applied.
+		 * @since 2.6
 		 */
 		public PopCommand count(long count) {
 			return new PopCommand(getKey(), count, direction);
@@ -954,12 +955,13 @@ default Mono<ByteBuffer> lPop(ByteBuffer key) {
 	}
 
 	/**
-	 * Removes and returns first element in list stored at {@literal key}.
+	 * Removes and returns first {@code count} elements in list stored at {@literal key}.
 	 *
 	 * @param key must not be {@literal null}.
 	 * @param count
 	 * @return
 	 * @see <a href="https://redis.io/commands/lpop">Redis Documentation: LPOP</a>
+	 * @since 2.6
 	 */
 	default Flux<ByteBuffer> lPop(ByteBuffer key, long count) {
 
@@ -983,12 +985,13 @@ default Mono<ByteBuffer> rPop(ByteBuffer key) {
 	}
 
 	/**
-	 * Removes and returns last element in list stored at {@literal key}.
+	 * Removes and returns last {@code count} elements in list stored at {@literal key}.
 	 *
 	 * @param key must not be {@literal null}.
 	 * @param count
 	 * @return
 	 * @see <a href="https://redis.io/commands/rpop">Redis Documentation: RPOP</a>
+	 * @since 2.6
 	 */
 	default Flux<ByteBuffer> rPop(ByteBuffer key, long count) {
 

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

@@ -202,12 +202,13 @@ default Long lPos(byte[] key, byte[] element) {
 	byte[] lPop(byte[] key);
 
 	/**
-	 * Removes and returns first element in list stored at {@code key}.
+	 * Removes and returns first {@code} elements in list stored at {@code key}.
 	 *
 	 * @param key must not be {@literal null}.
 	 * @param count
 	 * @return {@literal null} when key does not exist or used in pipeline / transaction.
 	 * @see <a href="https://redis.io/commands/lpop">Redis Documentation: LPOP</a>
+	 * @since 2.6
 	 */
 	@Nullable
 	List<byte[]> lPop(byte[] key, long count);
@@ -223,12 +224,13 @@ default Long lPos(byte[] key, byte[] element) {
 	byte[] rPop(byte[] key);
 
 	/**
-	 * Removes and returns last element in list stored at {@code key}.
+	 * Removes and returns last {@code} elements in list stored at {@code key}.
 	 *
 	 * @param key must not be {@literal null}.
 	 * @param count
 	 * @return {@literal null} when key does not exist or used in pipeline / transaction.
 	 * @see <a href="https://redis.io/commands/rpop">Redis Documentation: RPOP</a>
+	 * @since 2.6
 	 */
 	@Nullable
 	List<byte[]> rPop(byte[] key, long count);

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

@@ -843,13 +843,14 @@ default Long lPos(String key, String element) {
 	String lPop(String key);
 
 	/**
-	 * Removes and returns first element in list stored at {@code key}.
+	 * Removes and returns first {@code} elements in list stored at {@code key}.
 	 *
 	 * @param key must not be {@literal null}.
 	 * @param count
 	 * @return
 	 * @see <a href="https://redis.io/commands/lpop">Redis Documentation: LPOP</a>
 	 * @see RedisListCommands#lPop(byte[], long)
+	 * @since 2.6
 	 */
 	List<String> lPop(String key, long count);
 
@@ -864,13 +865,14 @@ default Long lPos(String key, String element) {
 	String rPop(String key);
 
 	/**
-	 * Removes and returns last element in list stored at {@code key}.
+	 * Removes and returns last {@code} elements in list stored at {@code key}.
 	 *
 	 * @param key must not be {@literal null}.
 	 * @param count
 	 * @return
 	 * @see <a href="https://redis.io/commands/rpop">Redis Documentation: RPOP</a>
 	 * @see RedisListCommands#rPop(byte[], long)
+	 * @since 2.6
 	 */
 	List<String> rPop(String key, long count);
 

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

@@ -277,6 +277,7 @@ public Flux<ByteBufferResponse<PopCommand>> pop(Publisher<PopCommand> commands)
 	 */
 	@Override
 	public Flux<CommandResponse<PopCommand, Flux<ByteBuffer>>> popList(Publisher<PopCommand> commands) {
+
 		return connection.execute(cmd -> Flux.from(commands).concatMap(command -> {
 
 			Assert.notNull(command.getKey(), "Key must not be null!");

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

@@ -200,6 +200,18 @@ public interface BoundListOperations<K, V> extends BoundKeyOperations<K> {
 	@Nullable
 	V leftPop();
 
+	/**
+	 * Removes and returns first {@code} elements in list stored at {@code key}.
+	 *
+	 * @param key must not be {@literal null}.
+	 * @param count
+	 * @return can be {@literal null}.
+	 * @see <a href="https://redis.io/commands/lpop">Redis Documentation: LPOP</a>
+	 * @since 2.6
+	 */
+	@Nullable
+	List<V> leftPop(long count);
+
 	/**
 	 * Removes and returns first element from lists stored at the bound key . <br>
 	 * <b>Blocks connection</b> until element available or {@code timeout} reached.
@@ -240,6 +252,18 @@ default V leftPop(Duration timeout) {
 	@Nullable
 	V rightPop();
 
+	/**
+	 * Removes and returns last {@code} elements in list stored at {@code key}.
+	 *
+	 * @param key must not be {@literal null}.
+	 * @param count
+	 * @return can be {@literal null}.
+	 * @see <a href="https://redis.io/commands/rpop">Redis Documentation: RPOP</a>
+	 * @since 2.6
+	 */
+	@Nullable
+	List<V> rightPop(long count);
+
 	/**
 	 * Removes and returns last element from lists stored at the bound key. <br>
 	 * <b>Blocks connection</b> until element available or {@code timeout} reached.

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

@@ -19,6 +19,7 @@
 import java.util.concurrent.TimeUnit;
 
 import org.springframework.data.redis.connection.DataType;
+import org.springframework.lang.Nullable;
 
 /**
  * Default implementation for {@link BoundListOperations}.
@@ -82,6 +83,15 @@ public V leftPop() {
 		return ops.leftPop(getKey());
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.core.BoundListOperations#leftPop(long)
+	 */
+	@Override
+	public List<V> leftPop(long count) {
+		return ops.leftPop(getKey(), count);
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.core.BoundListOperations#leftPop(long, java.util.concurrent.TimeUnit)
@@ -163,6 +173,15 @@ public V rightPop() {
 		return ops.rightPop(getKey());
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.core.BoundListOperations#rightPop(long)
+	 */
+	@Override
+	public List<V> rightPop(long count) {
+		return ops.rightPop(getKey(), count);
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.core.BoundListOperations#rightPop(long, java.util.concurrent.TimeUnit)

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

@@ -249,12 +249,13 @@ public interface ListOperations<K, V> {
 	V leftPop(K key);
 
 	/**
-	 * Removes and returns first element in list stored at {@code key}.
+	 * Removes and returns first {@code} elements in list stored at {@code key}.
 	 *
 	 * @param key must not be {@literal null}.
 	 * @param count
 	 * @return can be {@literal null}.
 	 * @see <a href="https://redis.io/commands/lpop">Redis Documentation: LPOP</a>
+	 * @since 2.6
 	 */
 	@Nullable
 	List<V> leftPop(K key, long count);
@@ -303,12 +304,13 @@ default V leftPop(K key, Duration timeout) {
 	V rightPop(K key);
 
 	/**
-	 * Removes and returns last element in list stored at {@code key}.
+	 * Removes and returns last {@code} elements in list stored at {@code key}.
 	 *
 	 * @param key must not be {@literal null}.
 	 * @param count
 	 * @return can be {@literal null}.
 	 * @see <a href="https://redis.io/commands/rpop">Redis Documentation: RPOP</a>
+	 * @since 2.6
 	 */
 	@Nullable
 	List<V> rightPop(K key, long count);

src/test/java/org/springframework/data/redis/connection/AbstractConnectionIntegrationTests.java

@@ -80,6 +80,7 @@
 import org.springframework.data.redis.serializer.RedisSerializer;
 import org.springframework.data.redis.test.condition.EnabledOnCommand;
 import org.springframework.data.redis.test.condition.EnabledOnRedisDriver;
+import org.springframework.data.redis.test.condition.EnabledOnRedisVersion;
 import org.springframework.data.redis.test.condition.LongRunningTest;
 import org.springframework.data.redis.test.condition.RedisDriver;
 import org.springframework.data.redis.test.util.HexStringUtils;
@@ -1286,6 +1287,16 @@ void testLPop() {
 		verifyResults(Arrays.asList(new Object[] { 1L, 2L, "hello" }));
 	}
 
+	@Test // GH-1987
+	@EnabledOnRedisVersion("6.2")
+	void testLPopWithCount() {
+		actual.add(connection.rPush("PopList", "hello"));
+		actual.add(connection.rPush("PopList", "world"));
+		actual.add(connection.rPush("PopList", "42"));
+		actual.add(connection.lPop("PopList", 2));
+		verifyResults(Arrays.asList(new Object[] { 1L, 2L, 3L, Arrays.asList("hello", "world") }));
+	}
+
 	@Test
 	void testLRem() {
 		actual.add(connection.rPush("PopList", "hello"));
@@ -1335,6 +1346,16 @@ void testRPop() {
 		verifyResults(Arrays.asList(new Object[] { 1L, 2L, "world" }));
 	}
 
+	@Test // GH-1987
+	@EnabledOnRedisVersion("6.2")
+	void testRPopWithCount() {
+		actual.add(connection.rPush("PopList", "hello"));
+		actual.add(connection.rPush("PopList", "world"));
+		actual.add(connection.rPush("PopList", "42"));
+		actual.add(connection.rPop("PopList", 2));
+		verifyResults(Arrays.asList(new Object[] { 1L, 2L, 3L, Arrays.asList("42", "world") }));
+	}
+
 	@Test
 	void testRPopLPush() {
 		actual.add(connection.rPush("PopList", "hello"));

src/test/java/org/springframework/data/redis/connection/DefaultStringRedisConnectionTests.java

@@ -670,14 +670,14 @@ public void testLPop() {
 		verifyResults(Collections.singletonList(bar));
 	}
 
-	@Test
+	@Test // GH-1987
 	public void testLPopCountBytes() {
 		doReturn(Collections.singletonList(barBytes)).when(nativeConnection).lPop(fooBytes, 2);
 		actual.add(connection.lPop(fooBytes, 2));
 		verifyResults(Collections.singletonList(bytesList));
 	}
 
-	@Test
+	@Test // GH-1987
 	public void testLPopCount() {
 		doReturn(Collections.singletonList(barBytes)).when(nativeConnection).lPop(fooBytes, 2);
 		actual.add(connection.lPop(foo, 2));
@@ -852,14 +852,14 @@ public void testRPop() {
 		verifyResults(Collections.singletonList(bar));
 	}
 
-	@Test
+	@Test // GH-1987
 	public void testRPopCountBytes() {
 		doReturn(Collections.singletonList(barBytes)).when(nativeConnection).rPop(fooBytes, 2);
 		actual.add(connection.rPop(fooBytes, 2));
 		verifyResults(Collections.singletonList(bytesList));
 	}
 
-	@Test
+	@Test // GH-1987
 	public void testRPopCount() {
 		doReturn(Collections.singletonList(barBytes)).when(nativeConnection).rPop(fooBytes, 2);
 		actual.add(connection.rPop(foo, 2));

src/test/java/org/springframework/data/redis/connection/DefaultStringRedisConnectionTxTests.java

@@ -509,6 +509,18 @@ public void testLPop() {
 		super.testLPop();
 	}
 
+	@Test // GH-1987
+	public void testLPopCountBytes() {
+		doReturn(Collections.singletonList(Collections.singletonList(barBytes))).when(nativeConnection).exec();
+		super.testLPopCountBytes();
+	}
+
+	@Test // GH-1987
+	public void testLPopCount() {
+		doReturn(Collections.singletonList(Collections.singletonList(barBytes))).when(nativeConnection).exec();
+		super.testLPopCount();
+	}
+
 	@Test
 	public void testLPushBytes() {
 		doReturn(Collections.singletonList(8L)).when(nativeConnection).exec();
@@ -653,6 +665,18 @@ public void testRPop() {
 		super.testRPop();
 	}
 
+	@Test // GH-1987
+	public void testRPopCountBytes() {
+		doReturn(Collections.singletonList(Collections.singletonList(barBytes))).when(nativeConnection).exec();
+		super.testRPopCountBytes();
+	}
+
+	@Test // GH-1987
+	public void testRPopCount() {
+		doReturn(Collections.singletonList(Collections.singletonList(barBytes))).when(nativeConnection).exec();
+		super.testRPopCount();
+	}
+
 	@Test
 	public void testRPopLPushBytes() {
 		doReturn(Arrays.asList(new Object[] { barBytes })).when(nativeConnection).exec();