DATAREDIS-729 - Polishing.

Reorder methods so lexCount(…) comes after count(…). Tweak Javadoc wording. Simplify tests.

Original pull request: #569.

Author: mp911de

src/main/asciidoc/new-features.adoc

@@ -9,6 +9,7 @@ This section briefly covers items that are new and noteworthy in the latest rele
 * `RedisCache` now exposes `CacheStatistics`.
 * ACL authentication support for Redis Standalone, Redis Cluster and Master/Replica.
 * Password support for Redis Sentinel using Jedis.
+* Support for `ZREVRANGEBYLEX` and `ZLEXCOUNT` commands.
 
 [[new-in-2.3.0]]
 == New in Spring Data Redis 2.3

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

@@ -1659,15 +1659,6 @@ public Long zUnionStore(byte[] destKey, byte[]... sets) {
 		return convertAndReturn(delegate.zUnionStore(destKey, sets), identityConverter);
 	}
 
-	/*
-	 * (non-Javadoc)
-	 * @see org.springframework.data.redis.connection.RedisZSetCommands#zLexCount(byte[], org.springframework.data.redis.connection.RedisZSetCommands.Range)
-	 */
-	@Override
-	public Long zLexCount(byte[] key, Range range) {
-		return delegate.zLexCount(key, range);
-	}
-
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.StringRedisConnection#zLexCount(java.lang.String, org.springframework.data.redis.connection.RedisZSetCommands.Range)
@@ -2727,6 +2718,15 @@ public Long zCount(String key, double min, double max) {
 		return zCount(serialize(key), min, max);
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisZSetCommands#zLexCount(byte[], org.springframework.data.redis.connection.RedisZSetCommands.Range)
+	 */
+	@Override
+	public Long zLexCount(byte[] key, Range range) {
+		return delegate.zLexCount(key, range);
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.StringRedisConnection#zIncrBy(java.lang.String, double, java.lang.String)

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

@@ -898,6 +898,13 @@ default Long zCount(byte[] key, double min, double max) {
 		return zSetCommands().zCount(key, min, max);
 	}
 
+	/** @deprecated in favor of {@link RedisConnection#zSetCommands()}}. */
+	@Override
+	@Deprecated
+	default Long zLexCount(byte[] key, Range range) {
+		return zSetCommands().zLexCount(key, range);
+	}
+
 	/** @deprecated in favor of {@link RedisConnection#zSetCommands()}}. */
 	@Override
 	@Deprecated
@@ -1094,13 +1101,6 @@ default Set<byte[]> zRangeByScore(byte[] key, String min, String max, long offse
 		return zSetCommands().zRangeByScore(key, min, max, offset, count);
 	}
 
-	/** @deprecated in favor of {@link RedisConnection#zSetCommands()}}. */
-	@Override
-	@Deprecated
-	default Long zLexCount(byte[] key, Range range) {
-		return zSetCommands().zLexCount(key, range);
-	}
-
 	// HASH COMMANDS
 
 	/** @deprecated in favor of {@link RedisConnection#hashCommands()}}. */

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

@@ -1121,6 +1121,82 @@ default Mono<Long> zCount(ByteBuffer key, Range<Double> range) {
 	 */
 	Flux<NumericResponse<ZCountCommand, Long>> zCount(Publisher<ZCountCommand> commands);
 
+	/**
+	 * {@code ZLEXCOUNT} command parameters.
+	 *
+	 * @author Andrey Shlykov
+	 * @since 2.4
+	 * @see <a href="https://redis.io/commands/zlexcount">Redis Documentation: ZLEXCOUNT</a>
+	 */
+	class ZLexCountCommand extends KeyCommand {
+
+		private final Range<String> range;
+
+		private ZLexCountCommand(@Nullable ByteBuffer key, Range<String> range) {
+			super(key);
+			this.range = range;
+		}
+
+		/**
+		 * Creates a new {@link ZLexCountCommand} given a {@link Range} of {@link String} to retrieve elements count.
+		 *
+		 * @param range must not be {@literal null}.
+		 * @return a new {@link ZLexCountCommand} for {@link Range}.
+		 */
+		public static ZLexCountCommand stringsWithin(Range<String> range) {
+
+			Assert.notNull(range, "Range must not be null!");
+
+			return new ZLexCountCommand(null, range);
+		}
+
+		/**
+		 * Applies the {@literal key}. Constructs a new command instance with all previously configured properties.
+		 *
+		 * @param key must not be {@literal null}.
+		 * @return a new {@link ZLexCountCommand} with {@literal key} applied.
+		 */
+		public ZLexCountCommand forKey(ByteBuffer key) {
+
+			Assert.notNull(key, "Key must not be null!");
+
+			return new ZLexCountCommand(key, range);
+		}
+
+		/**
+		 * @return
+		 */
+		public Range<String> getRange() {
+			return range;
+		}
+	}
+
+	/**
+	 * Count number of elements within sorted set with value between {@code Range#min} and {@code Range#max} applying
+	 * lexicographical ordering.
+	 *
+	 * @param key must not be {@literal null}.
+	 * @param range must not be {@literal null}.
+	 * @return
+	 * @since 2.4
+	 * @see <a href="https://redis.io/commands/zlexcount">Redis Documentation: ZLEXCOUNT</a>
+	 */
+	default Mono<Long> zLexCount(ByteBuffer key, Range<String> range) {
+		return zLexCount(Mono.just(ZLexCountCommand.stringsWithin(range).forKey(key))).next()
+				.map(NumericResponse::getOutput);
+	}
+
+	/**
+	 * Count number of elements within sorted set with value between {@code Range#min} and {@code Range#max} applying
+	 * lexicographical ordering.
+	 *
+	 * @param commands must not be {@literal null}.
+	 * @return
+	 * @since 2.4
+	 * @see <a href="https://redis.io/commands/zlexcount">Redis Documentation: ZLEXCOUNT</a>
+	 */
+	Flux<NumericResponse<ZLexCountCommand, Long>> zLexCount(Publisher<ZLexCountCommand> commands);
+
 	/**
 	 * Get the size of sorted set with {@literal key}.
 	 *
@@ -1937,78 +2013,4 @@ default Flux<ByteBuffer> zRevRangeByLex(ByteBuffer key, Range<String> range, Lim
 	 */
 	Flux<CommandResponse<ZRangeByLexCommand, Flux<ByteBuffer>>> zRangeByLex(Publisher<ZRangeByLexCommand> commands);
 
-	/**
-	 * {@code ZLEXCOUNT} command parameters.
-	 *
-	 * @author Andrey Shlykov
-	 * @see <a href="https://redis.io/commands/zlexcount">Redis Documentation: ZLEXCOUNT</a>
-	 */
-	class ZLexCountCommand extends KeyCommand {
-
-		private final Range<String> range;
-
-		private ZLexCountCommand(@Nullable ByteBuffer key, Range<String> range) {
-			super(key);
-			this.range = range;
-		}
-
-		/**
-		 * Creates a new {@link ZLexCountCommand} given a {@link Range} of {@link String} to retrieve elements
-		 * count.
-		 *
-		 * @param range must not be {@literal null}.
-		 * @return a new {@link ZLexCountCommand} for {@link Range}.
-		 */
-		public static ZLexCountCommand stringsWithin(Range<String> range) {
-
-			Assert.notNull(range, "Range must not be null!");
-
-			return new ZLexCountCommand(null, range);
-		}
-
-		/**
-		 * Applies the {@literal key}. Constructs a new command instance with all previously configured properties.
-		 *
-		 * @param key must not be {@literal null}.
-		 * @return a new {@link ZLexCountCommand} with {@literal key} applied.
-		 */
-		public ZLexCountCommand forKey(ByteBuffer key) {
-
-			Assert.notNull(key, "Key must not be null!");
-
-			return new ZLexCountCommand(key, range);
-		}
-
-		/**
-		 * @return
-		 */
-		public Range<String> getRange() {
-			return range;
-		}
-	}
-
-	/**
-	 * Count number of elements within sorted set with value within {@link Range}.
-	 *
-	 * @param key must not be {@literal null}.
-	 * @param range must not be {@literal null}.
-	 * @return
-	 * @since 2.4
-	 * @see <a href="https://redis.io/commands/zlexcount">Redis Documentation: ZLEXCOUNT</a>
-	 */
-	default Mono<Long> zLexCount(ByteBuffer key, Range<String> range) {
-		return zLexCount(Mono.just(ZLexCountCommand.stringsWithin(range).forKey(key))).next()
-				.map(NumericResponse::getOutput);
-	}
-
-	/**
-	 * Count number of elements within sorted set with value within {@link Range}.
-	 *
-	 * @param commands must not be {@literal null}.
-	 * @return
-	 * @since 2.4
-	 * @see <a href="https://redis.io/commands/zlexcount">Redis Documentation: ZLEXCOUNT</a>
-	 */
-	Flux<NumericResponse<ZLexCountCommand, Long>> zLexCount(Publisher<ZLexCountCommand> commands);
-
 }

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

@@ -768,6 +768,19 @@ default Long zCount(byte[] key, double min, double max) {
 	@Nullable
 	Long zCount(byte[] key, Range range);
 
+	/**
+	 * Count number of elements within sorted set with value between {@code Range#min} and {@code Range#max} applying
+	 * lexicographical ordering.
+	 *
+	 * @param key must not be {@literal null}.
+	 * @param range must not be {@literal null}.
+	 * @return {@literal null} when used in pipeline / transaction.
+	 * @since 2.4
+	 * @see <a href="https://redis.io/commands/zlexcount">Redis Documentation: ZLEXCOUNT</a>
+	 */
+	@Nullable
+	Long zLexCount(byte[] key, Range range);
+
 	/**
 	 * Get the size of sorted set with {@code key}.
 	 *
@@ -1059,16 +1072,4 @@ default Set<byte[]> zRevRangeByLex(byte[] key, Range range) {
 	@Nullable
 	Set<byte[]> zRevRangeByLex(byte[] key, Range range, Limit limit);
 
-	/**
-	 * Count number of elements within sorted set with value between {@code Range#min} and {@code Range#max}.
-	 *
-	 * @param key must not be {@literal null}.
-	 * @param range must not be {@literal null}.
-	 * @return {@literal null} when used in pipeline / transaction.
-	 * @since 2.4
-	 * @see <a href="https://redis.io/commands/zlexcount">Redis Documentation: ZLEXCOUNT</a>
-	 */
-	@Nullable
-	Long zLexCount(byte[] key, Range range);
-
 }

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

@@ -1329,6 +1329,20 @@ default Long lPos(String key, String element) {
 	 */
 	Long zCount(String key, double min, double max);
 
+	/**
+	 * Count number of elements within sorted set with value between {@code Range#min} and {@code Range#max} applying
+	 * lexicographical ordering.
+	 *
+	 * @param key must not be {@literal null}.
+	 * @param range must not be {@literal null}.
+	 * @return {@literal null} when used in pipeline / transaction.
+	 * @since 2.4
+	 * @see <a href="https://redis.io/commands/zlexcount">Redis Documentation: ZLEXCOUNT</a>
+	 * @see RedisZSetCommands#zLexCount(byte[], Range)
+	 */
+	@Nullable
+	Long zLexCount(String key, Range range);
+
 	/**
 	 * Get the size of sorted set with {@code key}.
 	 *
@@ -1541,19 +1555,6 @@ default Set<String> zRevRangeByLex(String key, Range range) {
 	 */
 	Set<String> zRevRangeByLex(String key, Range range, Limit limit);
 
-	/**
-	 * Count number of elements within sorted set with value between {@code Range#min} and {@code Range#max}.
-	 *
-	 * @param key must not be {@literal null}.
-	 * @param range must not be {@literal null}.
-	 * @return {@literal null} when used in pipeline / transaction.
-	 * @since 2.4
-	 * @see <a href="https://redis.io/commands/zlexcount">Redis Documentation: ZLEXCOUNT</a>
-	 * @see RedisZSetCommands#zLexCount(byte[], Range)
-	 */
-	@Nullable
-	Long zLexCount(String key, Range range);
-
 	// -------------------------------------------------------------------------
 	// Methods dealing with Redis Hashes
 	// -------------------------------------------------------------------------

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

@@ -257,6 +257,26 @@ public Long zCount(byte[] key, Range range) {
 		}
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.RedisZSetCommands#zLexCount(byte[], org.springframework.data.redis.connection.RedisZSetCommands.Range)
+	 */
+	@Override
+	public Long zLexCount(byte[] key, Range range) {
+
+		Assert.notNull(key, "Key must not be null!");
+		Assert.notNull(range, "Range must not be null!");
+
+		byte[] min = JedisConverters.boundaryToBytesForZRangeByLex(range.getMin(), JedisConverters.MINUS_BYTES);
+		byte[] max = JedisConverters.boundaryToBytesForZRangeByLex(range.getMax(), JedisConverters.PLUS_BYTES);
+
+		try {
+			return connection.getCluster().zlexcount(key, min, max);
+		} catch (Exception ex) {
+			throw convertJedisAccessException(ex);
+		}
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.redis.connection.RedisZSetCommands#zRemRangeByScore(byte[], org.springframework.data.redis.connection.RedisZSetCommands.Range)
@@ -795,26 +815,6 @@ public Set<byte[]> zRangeByScore(byte[] key, String min, String max, long offset
 		}
 	}
 
-	/*
-	 * (non-Javadoc)
-	 * @see org.springframework.data.redis.connection.RedisZSetCommands#zLexCount(byte[], org.springframework.data.redis.connection.RedisZSetCommands.Range)
-	 */
-	@Override
-	public Long zLexCount(byte[] key, Range range) {
-
-		Assert.notNull(key, "Key must not be null!");
-		Assert.notNull(range, "Range must not be null!");
-
-		byte[] min = JedisConverters.boundaryToBytesForZRangeByLex(range.getMin(), JedisConverters.MINUS_BYTES);
-		byte[] max = JedisConverters.boundaryToBytesForZRangeByLex(range.getMax(), JedisConverters.PLUS_BYTES);
-
-		try {
-			return connection.getCluster().zlexcount(key, min, max);
-		} catch (Exception ex) {
-			throw convertJedisAccessException(ex);
-		}
-	}
-
 	private DataAccessException convertJedisAccessException(Exception ex) {
 		return connection.convertJedisAccessException(ex);
 	}