DATAREDIS-471 - Polishing.

Update reference documentation. Enhance JavaDoc. Remove destroy of managed bean. Refactor property update of writePartialUpdate into own method. Remove trailing whitespaces in JavaDoc.

Original pull request: #191.

Author: mp911de

src/main/asciidoc/reference/redis-repositories.adoc

@@ -496,7 +496,7 @@ Indexes set on properties of referenced types will not be resolved.
 [[redis.repositories.partial-updates]]
 == Persisting Partial Updates
 In some cases it is not necessary to load and rewrite the entire entity just to set a new value within it. A session timestamp for last active time might be such a scenario where you just want to alter one property.
-`PartialUpdate` allows to define `set`, `delete` actions on existing objects while taking care of updating potential expiration times of the entity itself as well as index structures.
+`PartialUpdate` allows to define `set` and `delete` actions on existing objects while taking care of updating potential expiration times of the entity itself as well as index structures.
 
 .Sample Partial Update
 ====
@@ -521,7 +521,7 @@ update = new PartialUpdate<Person>("e2c7dcee", Person.class)
 
 template.update(update);
 ----
-<1> Set the simple property _firstname_ to _mat_
+<1> Set the simple property _firstname_ to _mat_.
 <2> Set the simple property _address.city_ to _emond's field_ without having to pass in the entire object. This does not work when a custom conversion is registered.
 <3> Remove the property _age_.
 <4> Set complex property _address_.

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

@@ -150,6 +150,7 @@ private void removeKeyFromExistingIndexes(byte[] key, Iterable<IndexedData> inde
 	protected void removeKeyFromExistingIndexes(byte[] key, IndexedData indexedData) {
 
 		Assert.notNull(indexedData, "IndexedData must not be null!");
+
 		Set<byte[]> existingKeys = connection
 				.keys(toBytes(indexedData.getKeyspace() + ":" + indexedData.getIndexName() + ":*"));
 
@@ -217,7 +218,8 @@ private byte[] toBytes(Object source) {
 		}
 
 		throw new InvalidDataAccessApiUsageException(String.format(
-				"Cannot convert %s to binary representation for index key generation. Are you missing a Converter? Did you register a non PathBasedRedisIndexDefinition that might apply to a complex type?",
+				"Cannot convert %s to binary representation for index key generation. "
+						+ "Are you missing a Converter? Did you register a non PathBasedRedisIndexDefinition that might apply to a complex type?",
 				source.getClass()));
 	}
 

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

@@ -114,6 +114,7 @@ public PartialUpdate<T> set(String path, Object value) {
 		PartialUpdate<T> update = new PartialUpdate<T>(this.id, this.target, this.value, this.refreshTtl,
 				this.propertyUpdates);
 		update.propertyUpdates.add(new PropertyUpdate(UpdateCommand.SET, path, value));
+
 		return update;
 	}
 
@@ -130,6 +131,7 @@ public PartialUpdate<T> del(String path) {
 		PartialUpdate<T> update = new PartialUpdate<T>(this.id, this.target, this.value, this.refreshTtl,
 				this.propertyUpdates);
 		update.propertyUpdates.add(new PropertyUpdate(UpdateCommand.DEL, path));
+
 		return update;
 	}
 

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

@@ -140,29 +140,6 @@ public void update(Object objectToUpdate) {
 		super.update(objectToUpdate);
 	}
 
-	/*
-	 * (non-Javadoc)
-	 * @see org.springframework.data.keyvalue.core.KeyValueTemplate#destroy()
-	 */
-	@Override
-	public void destroy() throws Exception {
-
-		execute(new RedisKeyValueCallback<Void>() {
-
-			@Override
-			public Void doInRedis(RedisKeyValueAdapter adapter) {
-
-				try {
-					adapter.destroy();
-				} catch (Exception e) {
-					throw new RedisSystemException(e.getMessage(), e);
-				}
-				return null;
-			}
-		});
-
-	}
-
 	protected void doPartialUpdate(final PartialUpdate<?> update) {
 
 		execute(new RedisKeyValueCallback<Void>() {

src/main/java/org/springframework/data/redis/core/convert/CompositeIndexResolver.java

@@ -72,6 +72,9 @@ public Set<IndexedData> resolveIndexesFor(TypeInformation<?> typeInformation, Ob
 		return data;
 	}
 
+	/* (non-Javadoc)
+	 * @see org.springframework.data.redis.core.convert.IndexResolver#resolveIndexesFor(java.lang.String, java.lang.String, org.springframework.data.util.TypeInformation, java.lang.Object)
+	 */
 	@Override
 	public Set<IndexedData> resolveIndexesFor(String keyspace, String path, TypeInformation<?> typeInformation,
 			Object value) {

src/main/java/org/springframework/data/redis/core/convert/IndexResolver.java

@@ -23,21 +23,30 @@
 /**
  * {@link IndexResolver} extracts secondary index structures to be applied on a given path, {@link PersistentProperty}
  * and value.
- * 
+ *
  * @author Christoph Strobl
  * @since 1.7
  */
 public interface IndexResolver {
 
 	/**
 	 * Resolves all indexes for given type information / value combination.
-	 * 
+	 *
 	 * @param typeInformation must not be {@literal null}.
 	 * @param value the actual value. Can be {@literal null}.
 	 * @return never {@literal null}.
 	 */
 	Set<IndexedData> resolveIndexesFor(TypeInformation<?> typeInformation, Object value);
 
+	/**
+	 * Resolves all indexes for given type information / value combination.
+	 *
+	 * @param keyspace must not be {@literal null}.
+	 * @param path must not be {@literal null}.
+	 * @param typeInformation must not be {@literal null}.
+	 * @param value the actual value. Can be {@literal null}.
+	 * @return never {@literal null}.
+	 */
 	Set<IndexedData> resolveIndexesFor(String keyspace, String path, TypeInformation<?> typeInformation, Object value);
 
 }

src/main/java/org/springframework/data/redis/core/convert/MappingRedisConverter.java

@@ -72,18 +72,18 @@
  * <br />
  * <strong>NOTE</strong> {@link MappingRedisConverter} is an {@link InitializingBean} and requires
  * {@link MappingRedisConverter#afterPropertiesSet()} to be called.
- * 
+ *
  * <pre>
  * <code>
  * &#64;RedisHash("persons")
  * class Person {
- * 
+ *
  *   &#64;Id String id;
  *   String firstname;
- * 
+ *
  *   List<String> nicknames;
  *   List<Person> coworkers;
- * 
+ *
  *   Address address;
  *   &#64;Reference Country nationality;
  * }
@@ -105,9 +105,10 @@
  * nationality=nationality:andora
  * </code>
  * </pre>
- * 
+ *
  * @author Christoph Strobl
  * @author Greg Turnquist
+ * @author Mark Paluch
  * @since 1.7
  */
 public class MappingRedisConverter implements RedisConverter, InitializingBean {
@@ -128,7 +129,7 @@ public class MappingRedisConverter implements RedisConverter, InitializingBean {
 
 	/**
 	 * Creates new {@link MappingRedisConverter}.
-	 * 
+	 *
 	 * @param context can be {@literal null}.
 	 */
 	MappingRedisConverter(RedisMappingContext context) {
@@ -137,7 +138,7 @@ public class MappingRedisConverter implements RedisConverter, InitializingBean {
 
 	/**
 	 * Creates new {@link MappingRedisConverter} and defaults {@link RedisMappingContext} when {@literal null}.
-	 * 
+	 *
 	 * @param mappingContext can be {@literal null}.
 	 * @param indexResolver can be {@literal null}.
 	 * @param referenceResolver must not be {@literal null}.
@@ -394,8 +395,8 @@ protected void writePartialUpdate(PartialUpdate<?> update, RedisData sink) {
 		RedisPersistentEntity<?> entity = mappingContext.getPersistentEntity(update.getTarget());
 
 		write(update.getValue(), sink);
-		if (sink.getBucket().keySet().contains("_class")) {
-			sink.getBucket().put("_class", null); // overwrite stuff in here
+		if (sink.getBucket().keySet().contains(TYPE_HINT_ALIAS)) {
+			sink.getBucket().put(TYPE_HINT_ALIAS, null); // overwrite stuff in here
 		}
 
 		if (update.isRefreshTtl() && !update.getPropertyUpdates().isEmpty()) {
@@ -411,86 +412,95 @@ protected void writePartialUpdate(PartialUpdate<?> update, RedisData sink) {
 			String path = pUpdate.getPropertyPath();
 
 			if (UpdateCommand.SET.equals(pUpdate.getCmd())) {
+				writePartialPropertyUpdate(update, pUpdate, sink, entity, path);
+			}
+		}
+	}
 
-				KeyValuePersistentProperty targetProperty = getTargetPropertyOrNullForPath(path, update.getTarget());
+	/**
+	 * @param update
+	 * @param pUpdate
+	 * @param sink
+	 * @param entity
+	 * @param path
+	 */
+	private void writePartialPropertyUpdate(PartialUpdate<?> update, PropertyUpdate pUpdate, RedisData sink,
+			RedisPersistentEntity<?> entity, String path) {
 
-				if (targetProperty == null) {
+		KeyValuePersistentProperty targetProperty = getTargetPropertyOrNullForPath(path, update.getTarget());
 
-					targetProperty = getTargetPropertyOrNullForPath(path.replaceAll("\\.\\[.*\\]", ""), update.getTarget());
+		if (targetProperty == null) {
 
-					TypeInformation<?> ti = targetProperty == null ? ClassTypeInformation.OBJECT
-							: (targetProperty.isMap()
-									? (targetProperty.getTypeInformation().getMapValueType() != null
-											? targetProperty.getTypeInformation().getMapValueType() : ClassTypeInformation.OBJECT)
-									: targetProperty.getTypeInformation().getActualType());
+			targetProperty = getTargetPropertyOrNullForPath(path.replaceAll("\\.\\[.*\\]", ""), update.getTarget());
 
-					writeInternal(entity.getKeySpace(), pUpdate.getPropertyPath(), pUpdate.getValue(), ti, sink);
-					continue;
-				}
+			TypeInformation<?> ti = targetProperty == null ? ClassTypeInformation.OBJECT
+					: (targetProperty.isMap()
+							? (targetProperty.getTypeInformation().getMapValueType() != null
+									? targetProperty.getTypeInformation().getMapValueType() : ClassTypeInformation.OBJECT)
+							: targetProperty.getTypeInformation().getActualType());
 
-				if (targetProperty.isAssociation()) {
+			writeInternal(entity.getKeySpace(), pUpdate.getPropertyPath(), pUpdate.getValue(), ti, sink);
+			return;
+		}
 
-					if (targetProperty.isCollectionLike()) {
+		if (targetProperty.isAssociation()) {
 
-						KeyValuePersistentEntity<?> ref = mappingContext.getPersistentEntity(
-								targetProperty.getAssociation().getInverse().getTypeInformation().getComponentType().getActualType());
+			if (targetProperty.isCollectionLike()) {
 
-						int i = 0;
-						for (Object o : (Collection<?>) pUpdate.getValue()) {
+				KeyValuePersistentEntity<?> ref = mappingContext.getPersistentEntity(
+						targetProperty.getAssociation().getInverse().getTypeInformation().getComponentType().getActualType());
 
-							Object refId = ref.getPropertyAccessor(o).getProperty(ref.getIdProperty());
-							sink.getBucket().put(pUpdate.getPropertyPath() + ".[" + i + "]",
-									toBytes(ref.getKeySpace() + ":" + refId));
-							i++;
-						}
-					} else {
-
-						KeyValuePersistentEntity<?> ref = mappingContext
-								.getPersistentEntity(targetProperty.getAssociation().getInverse().getTypeInformation());
+				int i = 0;
+				for (Object o : (Collection<?>) pUpdate.getValue()) {
 
-						Object refId = ref.getPropertyAccessor(pUpdate.getValue()).getProperty(ref.getIdProperty());
-						sink.getBucket().put(pUpdate.getPropertyPath(), toBytes(ref.getKeySpace() + ":" + refId));
-					}
+					Object refId = ref.getPropertyAccessor(o).getProperty(ref.getIdProperty());
+					sink.getBucket().put(pUpdate.getPropertyPath() + ".[" + i + "]", toBytes(ref.getKeySpace() + ":" + refId));
+					i++;
 				}
+			} else {
 
-				else if (targetProperty.isCollectionLike()) {
+				KeyValuePersistentEntity<?> ref = mappingContext
+						.getPersistentEntity(targetProperty.getAssociation().getInverse().getTypeInformation());
 
-					Collection<?> collection = pUpdate.getValue() instanceof Collection ? (Collection<?>) pUpdate.getValue()
-							: Collections.<Object> singleton(pUpdate.getValue());
-					writeCollection(entity.getKeySpace(), pUpdate.getPropertyPath(), collection,
-							targetProperty.getTypeInformation().getActualType(), sink);
-				} else if (targetProperty.isMap()) {
+				Object refId = ref.getPropertyAccessor(pUpdate.getValue()).getProperty(ref.getIdProperty());
+				sink.getBucket().put(pUpdate.getPropertyPath(), toBytes(ref.getKeySpace() + ":" + refId));
+			}
+		} else if (targetProperty.isCollectionLike()) {
 
-					Map<Object, Object> map = new HashMap<Object, Object>();
+			Collection<?> collection = pUpdate.getValue() instanceof Collection ? (Collection<?>) pUpdate.getValue()
+					: Collections.<Object> singleton(pUpdate.getValue());
+			writeCollection(entity.getKeySpace(), pUpdate.getPropertyPath(), collection,
+					targetProperty.getTypeInformation().getActualType(), sink);
+		} else if (targetProperty.isMap()) {
 
-					if (pUpdate.getValue() instanceof Map) {
-						map.putAll((Map<?, ?>) pUpdate.getValue());
-					} else if (pUpdate.getValue() instanceof Map.Entry) {
-						map.put(((Map.Entry<?, ?>) pUpdate.getValue()).getKey(), ((Map.Entry<?, ?>) pUpdate.getValue()).getValue());
-					} else {
-						throw new MappingException(
-								String.format("Cannot set update value for map property '%s' to '%s'. Please use a Map or Map.Entry.",
-										pUpdate.getPropertyPath(), pUpdate.getValue()));
-					}
+			Map<Object, Object> map = new HashMap<Object, Object>();
 
-					writeMap(entity.getKeySpace(), pUpdate.getPropertyPath(), targetProperty.getMapValueType(), map, sink);
-				} else {
+			if (pUpdate.getValue() instanceof Map) {
+				map.putAll((Map<?, ?>) pUpdate.getValue());
+			} else if (pUpdate.getValue() instanceof Entry) {
+				map.put(((Entry<?, ?>) pUpdate.getValue()).getKey(), ((Entry<?, ?>) pUpdate.getValue()).getValue());
+			} else {
+				throw new MappingException(
+						String.format("Cannot set update value for map property '%s' to '%s'. Please use a Map or Map.Entry.",
+								pUpdate.getPropertyPath(), pUpdate.getValue()));
+			}
 
-					writeInternal(entity.getKeySpace(), pUpdate.getPropertyPath(), pUpdate.getValue(),
-							targetProperty.getTypeInformation(), sink);
+			writeMap(entity.getKeySpace(), pUpdate.getPropertyPath(), targetProperty.getMapValueType(), map, sink);
+		} else {
 
-					Set<IndexedData> data = indexResolver.resolveIndexesFor(entity.getKeySpace(), pUpdate.getPropertyPath(),
-							targetProperty.getTypeInformation(), pUpdate.getValue());
+			writeInternal(entity.getKeySpace(), pUpdate.getPropertyPath(), pUpdate.getValue(),
+					targetProperty.getTypeInformation(), sink);
 
-					if (data.isEmpty()) {
+			Set<IndexedData> data = indexResolver.resolveIndexesFor(entity.getKeySpace(), pUpdate.getPropertyPath(),
+					targetProperty.getTypeInformation(), pUpdate.getValue());
 
-						data = indexResolver.resolveIndexesFor(entity.getKeySpace(), pUpdate.getPropertyPath(),
-								targetProperty.getOwner().getTypeInformation(), pUpdate.getValue());
+			if (data.isEmpty()) {
+
+				data = indexResolver.resolveIndexesFor(entity.getKeySpace(), pUpdate.getPropertyPath(),
+						targetProperty.getOwner().getTypeInformation(), pUpdate.getValue());
 
-					}
-					sink.addIndexedData(data);
-				}
 			}
+			sink.addIndexedData(data);
 		}
 	}
 
@@ -589,10 +599,10 @@ public void doWithPersistentProperty(KeyValuePersistentProperty persistentProper
 			}
 		});
 
-		writeAssiciation(keyspace, path, entity, value, sink);
+		writeAssociation(path, entity, value, sink);
 	}
 
-	private void writeAssiciation(final String keyspace, final String path, final KeyValuePersistentEntity<?> entity,
+	private void writeAssociation(final String path, final KeyValuePersistentEntity<?> entity,
 			final Object value, final RedisData sink) {
 
 		if (value == null) {
@@ -878,7 +888,7 @@ private Class<?> getTypeHint(String path, Bucket bucket, Class<?> fallback) {
 
 	/**
 	 * Convert given source to binary representation using the underlying {@link ConversionService}.
-	 * 
+	 *
 	 * @param source
 	 * @return
 	 * @throws ConverterNotFoundException
@@ -894,7 +904,7 @@ public byte[] toBytes(Object source) {
 
 	/**
 	 * Convert given binary representation to desired target type using the underlying {@link ConversionService}.
-	 * 
+	 *
 	 * @param source
 	 * @param type
 	 * @return
@@ -934,7 +944,7 @@ private Object toArray(Collection<Object> source, Class<?> arrayType, Class<?> v
 
 	/**
 	 * Set {@link CustomConversions} to be applied.
-	 * 
+	 *
 	 * @param customConversions
 	 */
 	public void setCustomConversions(CustomConversions customConversions) {