Switch from plain String to DataType for ScanOptions.

Move the type method from KeyScanOptionsBuilder to the ScanOptionsBuilder to allow removal of the former.
Add a test for the reactive variant and allow SCAN tests with TYPE option to be executed starting with Redis 6.0.

Original Pull Request: spring-projects#2109

Author: christophstrobl

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

@@ -17,13 +17,15 @@
 
 import java.util.StringJoiner;
 
+import org.springframework.data.redis.connection.DataType;
 import org.springframework.lang.Nullable;
 import org.springframework.util.StringUtils;
 
 /**
  * Options to be used for with {@literal SCAN} commands.
  *
  * @author Mark Paluch
+ * @author Christoph Strobl
  * @since 2.6
  */
 public class KeyScanOptions extends ScanOptions {
@@ -35,20 +37,21 @@ public class KeyScanOptions extends ScanOptions {
 
 	private final @Nullable String type;
 
-	private KeyScanOptions(@Nullable Long count, @Nullable String pattern, @Nullable byte[] bytePattern,
+	KeyScanOptions(@Nullable Long count, @Nullable String pattern, @Nullable byte[] bytePattern,
 			@Nullable String type) {
 
 		super(count, pattern, bytePattern);
 		this.type = type;
 	}
 
 	/**
-	 * Static factory method that returns a new {@link KeyScanOptionsBuilder}.
+	 * Static factory method that returns a new {@link ScanOptionsBuilder}.
 	 *
+	 * @param type 
 	 * @return
 	 */
-	public static KeyScanOptionsBuilder scanOptions() {
-		return new KeyScanOptionsBuilder();
+	public static ScanOptionsBuilder scanOptions(DataType type) {
+		return new ScanOptionsBuilder().type(type);
 	}
 
 	@Nullable
@@ -71,68 +74,4 @@ public String toOptionString() {
 
 		return joiner.toString();
 	}
-
-	public static class KeyScanOptionsBuilder extends ScanOptionsBuilder {
-
-		private @Nullable String type;
-
-		private KeyScanOptionsBuilder() {}
-
-		/**
-		 * Returns the current {@link KeyScanOptionsBuilder} configured with the given {@code count}.
-		 *
-		 * @param count
-		 * @return
-		 */
-		@Override
-		public KeyScanOptionsBuilder count(long count) {
-			super.count(count);
-			return this;
-		}
-
-		/**
-		 * Returns the current {@link KeyScanOptionsBuilder} configured with the given {@code pattern}.
-		 *
-		 * @param pattern
-		 * @return
-		 */
-		@Override
-		public KeyScanOptionsBuilder match(String pattern) {
-			super.match(pattern);
-			return this;
-		}
-
-		/**
-		 * Returns the current {@link KeyScanOptionsBuilder} configured with the given {@code pattern}.
-		 *
-		 * @param pattern
-		 * @return
-		 */
-		@Override
-		public KeyScanOptionsBuilder match(byte[] pattern) {
-			super.match(pattern);
-			return this;
-		}
-
-		/**
-		 * Returns the current {@link KeyScanOptionsBuilder} configured with the given {@code type}.
-		 *
-		 * @param type
-		 * @return
-		 */
-		public KeyScanOptionsBuilder type(String type) {
-			this.type = type;
-			return this;
-		}
-
-		/**
-		 * Builds a new {@link KeyScanOptions} objects.
-		 *
-		 * @return a new {@link KeyScanOptions} objects.
-		 */
-		@Override
-		public KeyScanOptions build() {
-			return new KeyScanOptions(count, pattern, bytePattern, type);
-		}
-	}
 }

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

@@ -17,7 +17,9 @@
 
 import java.util.StringJoiner;
 
+import org.springframework.data.redis.connection.DataType;
 import org.springframework.lang.Nullable;
+import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
 
 /**
@@ -41,6 +43,7 @@ public class ScanOptions {
 	private final @Nullable byte[] bytePattern;
 
 	ScanOptions(@Nullable Long count, @Nullable String pattern, @Nullable byte[] bytePattern) {
+
 		this.count = count;
 		this.pattern = pattern;
 		this.bytePattern = bytePattern;
@@ -110,14 +113,15 @@ public static class ScanOptionsBuilder {
 		@Nullable Long count;
 		@Nullable String pattern;
 		@Nullable byte[] bytePattern;
+		@Nullable DataType type;
 
 		ScanOptionsBuilder() {}
 
 		/**
 		 * Returns the current {@link ScanOptionsBuilder} configured with the given {@code count}.
 		 *
 		 * @param count
-		 * @return
+		 * @return this.
 		 */
 		public ScanOptionsBuilder count(long count) {
 			this.count = count;
@@ -128,7 +132,7 @@ public ScanOptionsBuilder count(long count) {
 		 * Returns the current {@link ScanOptionsBuilder} configured with the given {@code pattern}.
 		 *
 		 * @param pattern
-		 * @return
+		 * @return this.
 		 */
 		public ScanOptionsBuilder match(String pattern) {
 			this.pattern = pattern;
@@ -139,20 +143,54 @@ public ScanOptionsBuilder match(String pattern) {
 		 * Returns the current {@link ScanOptionsBuilder} configured with the given {@code pattern}.
 		 *
 		 * @param pattern
-		 * @return
+		 * @return this.
 		 * @since 2.6
 		 */
 		public ScanOptionsBuilder match(byte[] pattern) {
 			this.bytePattern = pattern;
 			return this;
 		}
 
+		/**
+		 * Returns the current {@link ScanOptionsBuilder} configured with the given {@code type}. <br />
+		 * Please verify the the targeted command supports the
+		 * <a href="https://redis.io/commands/SCAN#the-type-option">TYPE</a> option before use.
+		 *
+		 * @param type must not be {@literal null}. Either do not set or use {@link DataType#NONE}.
+		 * @return this.
+		 * @since 2.6
+		 */
+		public ScanOptionsBuilder type(DataType type) {
+
+			Assert.notNull(type, "Type must not be null! Use NONE instead.");
+
+			this.type = type;
+			return this;
+		}
+
+		/**
+		 * Returns the current {@link ScanOptionsBuilder} configured with the given {@code type}.
+		 *
+		 * @param type the textual representation of {@link DataType#fromCode(String)}. Must not be {@literal null}.
+		 * @return this.
+		 * @throws IllegalArgumentException if given type is {@literal null} or unknown.
+		 */
+		public ScanOptionsBuilder type(String type) {
+
+			Assert.notNull(type, "Type must not be null!");
+			return type(DataType.fromCode(type));
+		}
+
 		/**
 		 * Builds a new {@link ScanOptions} objects.
 		 *
 		 * @return a new {@link ScanOptions} objects.
 		 */
 		public ScanOptions build() {
+
+			if (type != null && !DataType.NONE.equals(type)) {
+				return new KeyScanOptions(count, pattern, bytePattern, type.code());
+			}
 			return new ScanOptions(count, pattern, bytePattern);
 		}
 	}

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

@@ -2598,7 +2598,7 @@ void scanShouldReadEntireValueRange() {
 
 	@Test // GH-2089
 	@EnabledOnRedisDriver(RedisDriver.LETTUCE)
-	@EnabledOnRedisVersion("6.2")
+	@EnabledOnRedisVersion("6.0")
 	void scanWithType() {
 
 		assumeThat(connection.isPipelined() || connection.isQueueing())

src/test/java/org/springframework/data/redis/connection/lettuce/LettuceReactiveKeyCommandsIntegrationTests.java

@@ -35,8 +35,10 @@
 import org.springframework.data.redis.connection.ReactiveRedisConnection.KeyCommand;
 import org.springframework.data.redis.connection.ReactiveRedisConnection.NumericResponse;
 import org.springframework.data.redis.connection.ValueEncoding.RedisValueEncoding;
+import org.springframework.data.redis.core.KeyScanOptions;
 import org.springframework.data.redis.core.ScanOptions;
 import org.springframework.data.redis.test.condition.EnabledOnCommand;
+import org.springframework.data.redis.test.condition.EnabledOnRedisVersion;
 import org.springframework.data.redis.test.extension.parametrized.ParameterizedRedisTest;
 
 /**
@@ -115,6 +117,30 @@ void scanShouldShouldIterateOverKeyspace() {
 				.verifyComplete();
 	}
 
+	@ParameterizedRedisTest // GH-2089
+	@EnabledOnRedisVersion("6.0")
+	void scanWithType() {
+
+		nativeCommands.set(KEY_1, VALUE_1);
+		nativeCommands.lpush(KEY_2, VALUE_2);
+		nativeCommands.sadd(KEY_3, VALUE_3);
+
+		connection.keyCommands().scan(KeyScanOptions.scanOptions(DataType.STRING).build()) //
+				.as(StepVerifier::create) //
+				.expectNext(KEY_1_BBUFFER) //
+				.verifyComplete();
+
+		connection.keyCommands().scan(KeyScanOptions.scanOptions(DataType.SET).build()) //
+				.as(StepVerifier::create) //
+				.expectNext(KEY_3_BBUFFER) //
+				.verifyComplete();
+
+		connection.keyCommands().scan(KeyScanOptions.scanOptions(DataType.NONE).build()) //
+				.as(StepVerifier::create) //
+				.expectNextCount(3) //
+				.verifyComplete();
+	}
+
 	@ParameterizedRedisTest // DATAREDIS-525
 	void randomKeyShouldReturnAnyKey() {