Polish for RedisSerializationContext.

Closes #2651
Original pull request: #2652

Author: jxblum

src/main/java/org/springframework/data/redis/serializer/DefaultRedisSerializationContext.java

@@ -24,7 +24,7 @@
  * @author Mark Paluch
  * @author Christoph Strobl
  * @author Shyngys Sapraliyev
- * @author Zhou KQ
+ * @author John Blum
  * @since 2.0
  */
 class DefaultRedisSerializationContext<K, V> implements RedisSerializationContext<K, V> {
@@ -36,7 +36,8 @@ class DefaultRedisSerializationContext<K, V> implements RedisSerializationContex
 	private final SerializationPair<String> stringTuple;
 
 	private DefaultRedisSerializationContext(SerializationPair<K> keyTuple, SerializationPair<V> valueTuple,
-			SerializationPair<?> hashKeyTuple, SerializationPair<?> hashValueTuple, SerializationPair<String> stringTuple) {
+			SerializationPair<?> hashKeyTuple, SerializationPair<?> hashValueTuple,
+			SerializationPair<String> stringTuple) {
 
 		this.keyTuple = keyTuple;
 		this.valueTuple = valueTuple;
@@ -50,15 +51,15 @@ private DefaultRedisSerializationContext(SerializationPair<K> keyTuple, Serializ
 	 */
 	@Override
 	public SerializationPair<K> getKeySerializationPair() {
-		return keyTuple;
+		return this.keyTuple;
 	}
 
 	/* (non-Javadoc)
 	 * @see org.springframework.data.redis.serializer.RedisSerializationContext#getValueSerializationPair()
 	 */
 	@Override
 	public SerializationPair<V> getValueSerializationPair() {
-		return valueTuple;
+		return this.valueTuple;
 	}
 
 	/* (non-Javadoc)
@@ -67,7 +68,7 @@ public SerializationPair<V> getValueSerializationPair() {
 	@Override
 	@SuppressWarnings("unchecked")
 	public <HK> SerializationPair<HK> getHashKeySerializationPair() {
-		return (SerializationPair) hashKeyTuple;
+		return (SerializationPair<HK>) this.hashKeyTuple;
 	}
 
 	/* (non-Javadoc)
@@ -76,22 +77,23 @@ public <HK> SerializationPair<HK> getHashKeySerializationPair() {
 	@Override
 	@SuppressWarnings("unchecked")
 	public <HV> SerializationPair<HV> getHashValueSerializationPair() {
-		return (SerializationPair) hashValueTuple;
+		return (SerializationPair<HV>) this.hashValueTuple;
 	}
 
 	/* (non-Javadoc)
 	 * @see org.springframework.data.redis.serializer.RedisSerializationContext#getStringSerializationPair()
 	 */
 	@Override
 	public SerializationPair<String> getStringSerializationPair() {
-		return stringTuple;
+		return this.stringTuple;
 	}
 
 	/**
 	 * Default implementation of {@link RedisSerializationContextBuilder}.
 	 *
 	 * @author Mark Paluch
 	 * @author Christoph Strobl
+	 * @author Zhou KQ
 	 * @since 2.0
 	 */
 	static class DefaultRedisSerializationContextBuilder<K, V> implements RedisSerializationContextBuilder<K, V> {
@@ -100,6 +102,7 @@ static class DefaultRedisSerializationContextBuilder<K, V> implements RedisSeria
 		private @Nullable SerializationPair<V> valueTuple;
 		private @Nullable SerializationPair<?> hashKeyTuple;
 		private @Nullable SerializationPair<?> hashValueTuple;
+
 		private SerializationPair<String> stringTuple = SerializationPair.fromSerializer(RedisSerializer.string());
 
 		/* (non-Javadoc)
@@ -111,6 +114,7 @@ public RedisSerializationContextBuilder<K, V> key(SerializationPair<K> tuple) {
 			Assert.notNull(tuple, "SerializationPair must not be null!");
 
 			this.keyTuple = tuple;
+
 			return this;
 		}
 
@@ -123,6 +127,7 @@ public RedisSerializationContextBuilder<K, V> value(SerializationPair<V> tuple)
 			Assert.notNull(tuple, "SerializationPair must not be null!");
 
 			this.valueTuple = tuple;
+
 			return this;
 		}
 
@@ -135,6 +140,7 @@ public RedisSerializationContextBuilder<K, V> hashKey(SerializationPair<?> tuple
 			Assert.notNull(tuple, "SerializationPair must not be null!");
 
 			this.hashKeyTuple = tuple;
+
 			return this;
 		}
 
@@ -147,6 +153,7 @@ public RedisSerializationContextBuilder<K, V> hashValue(SerializationPair<?> tup
 			Assert.notNull(tuple, "SerializationPair must not be null!");
 
 			this.hashValueTuple = tuple;
+
 			return this;
 		}
 
@@ -159,6 +166,7 @@ public RedisSerializationContextBuilder<K, V> string(SerializationPair<String> t
 			Assert.notNull(tuple, "SerializationPair must not be null!");
 
 			this.stringTuple = tuple;
+
 			return this;
 		}
 
@@ -168,13 +176,13 @@ public RedisSerializationContextBuilder<K, V> string(SerializationPair<String> t
 		@Override
 		public RedisSerializationContext<K, V> build() {
 
-			Assert.notNull(keyTuple, "Key SerializationPair must not be null!");
-			Assert.notNull(valueTuple, "Value SerializationPair must not be null!");
-			Assert.notNull(hashKeyTuple, "HashKey SerializationPair must not be null!");
-			Assert.notNull(hashValueTuple, "HashValue SerializationPair must not be null!");
+			Assert.notNull(this.keyTuple, "Key SerializationPair must not be null");
+			Assert.notNull(this.valueTuple, "Value SerializationPair must not be null");
+			Assert.notNull(this.hashKeyTuple, "HashKey SerializationPair must not be null");
+			Assert.notNull(this.hashValueTuple, "HashValue SerializationPair must not be null");
 
-			return new DefaultRedisSerializationContext<>(keyTuple, valueTuple, hashKeyTuple, hashValueTuple,
-					stringTuple);
+			return new DefaultRedisSerializationContext<>(this.keyTuple, this.valueTuple,
+					this.hashKeyTuple, this.hashValueTuple, this.stringTuple);
 		}
 	}
 }

src/main/java/org/springframework/data/redis/serializer/RedisSerializationContext.java

@@ -27,6 +27,7 @@
  *
  * @author Mark Paluch
  * @author Christoph Strobl
+ * @author John Blum
  * @since 2.0
  * @see RedisElementWriter
  * @see RedisElementReader
@@ -40,9 +41,8 @@ public interface RedisSerializationContext<K, V> {
 	 * @param <V> expected value type.
 	 * @return a new {@link RedisSerializationContextBuilder}.
 	 */
-	@SuppressWarnings("unchecked")
 	static <K, V> RedisSerializationContextBuilder<K, V> newSerializationContext() {
-		return new DefaultRedisSerializationContext.DefaultRedisSerializationContextBuilder();
+		return new DefaultRedisSerializationContext.DefaultRedisSerializationContextBuilder<>();
 	}
 
 	/**
@@ -68,7 +68,7 @@ static <K, V> RedisSerializationContextBuilder<K, V> newSerializationContext(Red
 	 * @param <V> expected value type.
 	 * @return a new {@link RedisSerializationContextBuilder}.
 	 */
-	@SuppressWarnings("unchecked")
+	@SuppressWarnings({ "rawtypes", "unchecked" })
 	static <K, V> RedisSerializationContextBuilder<K, V> newSerializationContext(SerializationPair<?> serializationPair) {
 
 		Assert.notNull(serializationPair, "SerializationPair must not be null!");
@@ -114,7 +114,7 @@ static RedisSerializationContext<ByteBuffer, ByteBuffer> byteBuffer() {
 	/**
 	 * Creates a new {@link RedisSerializationContext} using a {@link JdkSerializationRedisSerializer}.
 	 *
-	 * @return new instance of {@link RedisSerializationContext}.
+	 * @return a new {@link RedisSerializationContext} using JDK Serializaton.
 	 * @since 2.1
 	 */
 	static RedisSerializationContext<Object, Object> java() {
@@ -123,10 +123,11 @@ static RedisSerializationContext<Object, Object> java() {
 
 	/**
 	 * Creates a new {@link RedisSerializationContext} using a {@link JdkSerializationRedisSerializer} with given
-	 * {@link ClassLoader}.
+	 * {@link ClassLoader} to resolves {@link Class type} of the keys and values stored in Redis.
 	 *
-	 * @param classLoader the {@link ClassLoader} to use for deserialization. Can be {@literal null}.
-	 * @return new instance of {@link RedisSerializationContext}.
+	 * @param classLoader {@link ClassLoader} used to resolve {@link Class types} of keys and value stored in Redis
+	 * during deserialization; can be {@literal null}.
+	 * @return a new {@link RedisSerializationContext} using JDK Serializaton.
 	 * @since 2.1
 	 */
 	static RedisSerializationContext<Object, Object> java(ClassLoader classLoader) {
@@ -136,7 +137,7 @@ static RedisSerializationContext<Object, Object> java(ClassLoader classLoader) {
 	/**
 	 * Creates a new {@link RedisSerializationContext} using a {@link StringRedisSerializer}.
 	 *
-	 * @return
+	 * @return a new {@link RedisSerializationContext} using a {@link StringRedisSerializer}.
 	 */
 	static RedisSerializationContext<String, String> string() {
 		return fromSerializer(RedisSerializer.string());
@@ -145,9 +146,10 @@ static RedisSerializationContext<String, String> string() {
 	/**
 	 * Creates a new {@link RedisSerializationContext} using the given {@link RedisSerializer}.
 	 *
-	 * @param serializer must not be {@literal null}.
-	 * @param <T>
-	 * @return
+	 * @param <T> {@link Class Type} of {@link Object} being de/serialized by the {@link RedisSerializer}.
+	 * @param serializer {@link RedisSerializer} used to de/serialize keys and value stored in Redis;
+	 * must not be {@literal null}.
+	 * @return a new {@link RedisSerializationContext} using the given {@link RedisSerializer}.
 	 */
 	static <T> RedisSerializationContext<T, T> fromSerializer(RedisSerializer<T> serializer) {
 		return just(SerializationPair.fromSerializer(serializer));
@@ -156,9 +158,10 @@ static <T> RedisSerializationContext<T, T> fromSerializer(RedisSerializer<T> ser
 	/**
 	 * Creates a new {@link RedisSerializationContext} using the given {@link SerializationPair}.
 	 *
-	 * @param serializationPair
-	 * @param <T>
-	 * @return
+	 * @param <T> {@link Class Type} of {@link Object} de/serialized by the {@link SerializationPair}.
+	 * @param serializationPair {@link SerializationPair} used to de/serialize keys and values stored in Redis;
+	 * must not be {@literal null}.
+	 * @return a new {@link RedisSerializationContext} using the given {@link SerializationPair}.
 	 */
 	static <T> RedisSerializationContext<T, T> just(SerializationPair<T> serializationPair) {
 		return RedisSerializationContext.<T, T> newSerializationContext(serializationPair).build();
@@ -278,10 +281,10 @@ default T read(ByteBuffer buffer) {
 		RedisElementWriter<T> getWriter();
 
 		/**
-		 * Serialize a {@code element} to its {@link ByteBuffer} representation.
+		 * Serialize the given {@code element} to its {@link ByteBuffer} representation.
 		 *
-		 * @param element
-		 * @return the {@link ByteBuffer} representing {@code element} in its binary form.
+		 * @param element {@link Object} to write (serialize) as a stream of bytes.
+		 * @return the {@link ByteBuffer} representing the given {@code element} in binary form.
 		 */
 		default ByteBuffer write(T element) {
 			return getWriter().write(element);
@@ -314,6 +317,7 @@ interface RedisSerializationContextBuilder<K, V> {
 		default RedisSerializationContextBuilder<K, V> key(RedisElementReader<K> reader, RedisElementWriter<K> writer) {
 
 			key(SerializationPair.just(reader, writer));
+
 			return this;
 		}
 
@@ -326,6 +330,7 @@ default RedisSerializationContextBuilder<K, V> key(RedisElementReader<K> reader,
 		default RedisSerializationContextBuilder<K, V> key(RedisSerializer<K> serializer) {
 
 			key(SerializationPair.fromSerializer(serializer));
+
 			return this;
 		}
 
@@ -347,6 +352,7 @@ default RedisSerializationContextBuilder<K, V> key(RedisSerializer<K> serializer
 		default RedisSerializationContextBuilder<K, V> value(RedisElementReader<V> reader, RedisElementWriter<V> writer) {
 
 			value(SerializationPair.just(reader, writer));
+
 			return this;
 		}
 
@@ -359,6 +365,7 @@ default RedisSerializationContextBuilder<K, V> value(RedisElementReader<V> reade
 		default RedisSerializationContextBuilder<K, V> value(RedisSerializer<V> serializer) {
 
 			value(SerializationPair.fromSerializer(serializer));
+
 			return this;
 		}
 
@@ -377,10 +384,11 @@ default RedisSerializationContextBuilder<K, V> value(RedisSerializer<V> serializ
 		 * @param writer must not be {@literal null}.
 		 * @return {@literal this} builder.
 		 */
-		default RedisSerializationContextBuilder<K, V> hashKey(RedisElementReader<? extends Object> reader,
-				RedisElementWriter<? extends Object> writer) {
+		default RedisSerializationContextBuilder<K, V> hashKey(RedisElementReader<?> reader,
+				RedisElementWriter<?> writer) {
 
 			hashKey(SerializationPair.just(reader, writer));
+
 			return this;
 		}
 
@@ -390,9 +398,10 @@ default RedisSerializationContextBuilder<K, V> hashKey(RedisElementReader<? exte
 		 * @param serializer must not be {@literal null}.
 		 * @return {@literal this} builder.
 		 */
-		default RedisSerializationContextBuilder<K, V> hashKey(RedisSerializer<? extends Object> serializer) {
+		default RedisSerializationContextBuilder<K, V> hashKey(RedisSerializer<?> serializer) {
 
 			hashKey(SerializationPair.fromSerializer(serializer));
+
 			return this;
 		}
 
@@ -411,10 +420,11 @@ default RedisSerializationContextBuilder<K, V> hashKey(RedisSerializer<? extends
 		 * @param writer must not be {@literal null}.
 		 * @return {@literal this} builder.
 		 */
-		default RedisSerializationContextBuilder<K, V> hashValue(RedisElementReader<? extends Object> reader,
-				RedisElementWriter<? extends Object> writer) {
+		default RedisSerializationContextBuilder<K, V> hashValue(RedisElementReader<?> reader,
+				RedisElementWriter<?> writer) {
 
 			hashValue(SerializationPair.just(reader, writer));
+
 			return this;
 		}
 
@@ -424,9 +434,10 @@ default RedisSerializationContextBuilder<K, V> hashValue(RedisElementReader<? ex
 		 * @param serializer must not be {@literal null}.
 		 * @return {@literal this} builder.
 		 */
-		default RedisSerializationContextBuilder<K, V> hashValue(RedisSerializer<? extends Object> serializer) {
+		default RedisSerializationContextBuilder<K, V> hashValue(RedisSerializer<?> serializer) {
 
 			hashValue(SerializationPair.fromSerializer(serializer));
+
 			return this;
 		}
 
@@ -449,6 +460,7 @@ default RedisSerializationContextBuilder<K, V> string(RedisElementReader<String>
 				RedisElementWriter<String> writer) {
 
 			string(SerializationPair.just(reader, writer));
+
 			return this;
 		}
 
@@ -461,6 +473,7 @@ default RedisSerializationContextBuilder<K, V> string(RedisElementReader<String>
 		default RedisSerializationContextBuilder<K, V> string(RedisSerializer<String> serializer) {
 
 			string(SerializationPair.fromSerializer(serializer));
+
 			return this;
 		}
 
@@ -470,5 +483,6 @@ default RedisSerializationContextBuilder<K, V> string(RedisSerializer<String> se
 		 * @return the {@link RedisSerializationContext}.
 		 */
 		RedisSerializationContext<K, V> build();
+
 	}
 }