Polish.

Additionally, refactors and cleans up the Redis cache extension and infrastructure.

Closes #2583

Author: jxblum

src/main/java/org/springframework/data/redis/cache/CacheKeyPrefix.java

@@ -18,11 +18,12 @@
 import org.springframework.util.Assert;
 
 /**
- * {@link CacheKeyPrefix} provides a hook for creating custom prefixes prepended to the actual {@literal key} stored in
- * Redis.
+ * {@link CacheKeyPrefix} is a callback hook for creating custom prefixes prepended to the actual {@literal key}
+ * stored in Redis.
  *
  * @author Christoph Strobl
  * @author Mark Paluch
+ * @author John Blum
  * @since 2.0.4
  */
 @FunctionalInterface
@@ -36,16 +37,20 @@ public interface CacheKeyPrefix {
 	String SEPARATOR = "::";
 
 	/**
-	 * Compute the prefix for the actual {@literal key} stored in Redis.
+	 * Compute the {@link String prefix} for the actual {@literal cache key} stored in Redis.
 	 *
-	 * @param cacheName will never be {@literal null}.
-	 * @return never {@literal null}.
+	 * @param cacheName {@link String name} of the cache in which the key is stored;
+	 * will never be {@literal null}.
+	 * @return the computed {@link String prefix} of the {@literal cache key} stored in Redis;
+	 * never {@literal null}.
 	 */
 	String compute(String cacheName);
 
 	/**
-	 * Creates a default {@link CacheKeyPrefix} scheme that prefixes cache keys with {@code cacheName} followed by double
-	 * colons. A cache named {@code myCache} will prefix all cache keys with {@code myCache::}.
+	 * Creates a default {@link CacheKeyPrefix} scheme that prefixes cache keys with the {@link String name}
+	 * of the cache followed by double colons.
+	 *
+	 * For example, a cache named {@literal myCache} will prefix all cache keys with {@literal myCache::}.
 	 *
 	 * @return the default {@link CacheKeyPrefix} scheme.
 	 */
@@ -54,9 +59,12 @@ static CacheKeyPrefix simple() {
 	}
 
 	/**
-	 * Creates a {@link CacheKeyPrefix} scheme that prefixes cache keys with the given {@code prefix}. The prefix is
-	 * prepended to the {@code cacheName} followed by double colons. A prefix {@code redis-} with a cache named
-	 * {@code myCache} results in {@code redis-myCache::}.
+	 * Creates a {@link CacheKeyPrefix} scheme that prefixes cache keys with the given {@link String prefix}.
+	 *
+	 * The {@link String prefix} is prepended to the {@link String cacheName} followed by double colons.
+	 *
+	 * For example, a prefix {@literal redis-} with a cache named {@literal  myCache}
+	 * results in {@literal  redis-myCache::}.
 	 *
 	 * @param prefix must not be {@literal null}.
 	 * @return the default {@link CacheKeyPrefix} scheme.
@@ -65,6 +73,7 @@ static CacheKeyPrefix simple() {
 	static CacheKeyPrefix prefixed(String prefix) {
 
 		Assert.notNull(prefix, "Prefix must not be null");
+
 		return name -> prefix + name + SEPARATOR;
 	}
 }