DATAREDIS-574 - Polishing.

Updated reference Documentation, JavaDoc and add some minor code changes (rename methods, fix return types, diamond operators,…). Original Pull Request: spring-projects#236

Author: christophstrobl

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

@@ -678,9 +678,7 @@ class RedisOperationsProducer {
  @Produces
  RedisConnectionFactory redisConnectionFactory() {
 
- JedisConnectionFactory jedisConnectionFactory = new JedisConnectionFactory();
- jedisConnectionFactory.setHostName("localhost");
- jedisConnectionFactory.setPort(6379);
+ JedisConnectionFactory jedisConnectionFactory = new JedisConnectionFactory(new RedisStandaloneConfiguration());
  jedisConnectionFactory.afterPropertiesSet();
 
  return jedisConnectionFactory;

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2016 the original author or authors.
+ * Copyright 2015-2017 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -53,7 +53,7 @@ public class RedisClusterConfiguration {
  * Creates new {@link RedisClusterConfiguration}.
  */
 public RedisClusterConfiguration() {
-this(new MapPropertySource("RedisClusterConfiguration", Collections.<String, Object> emptyMap()));
+this(new MapPropertySource("RedisClusterConfiguration", Collections.emptyMap()));
 }
 
 /**
@@ -64,12 +64,13 @@ public RedisClusterConfiguration() {
  * clusterHostAndPorts[0] = 127.0.0.1:23679
  * clusterHostAndPorts[1] = 127.0.0.1:23680 ...
  * </code>
+ *
  * <pre>
  *
  * @param clusterNodes must not be {@literal null}.
  */
 public RedisClusterConfiguration(Collection<String> clusterNodes) {
-this(new MapPropertySource("RedisClusterConfiguration", asMap(clusterNodes, -1, -1, null)));
+this(new MapPropertySource("RedisClusterConfiguration", asMap(clusterNodes, -1)));
 }
 
 /**
@@ -90,11 +91,11 @@ public RedisClusterConfiguration(PropertySource<?> propertySource) {
 
 notNull(propertySource, "PropertySource must not be null!");
 
-this.clusterNodes = new LinkedHashSet<RedisNode>();
+this.clusterNodes = new LinkedHashSet<>();
 
 if (propertySource.containsProperty(REDIS_CLUSTER_NODES_CONFIG_PROPERTY)) {
-appendClusterNodes(commaDelimitedListToSet(propertySource.getProperty(REDIS_CLUSTER_NODES_CONFIG_PROPERTY)
-.toString()));
+appendClusterNodes(
+commaDelimitedListToSet(propertySource.getProperty(REDIS_CLUSTER_NODES_CONFIG_PROPERTY).toString()));
 }
 if (propertySource.containsProperty(REDIS_CLUSTER_MAX_REDIRECTS_CONFIG_PROPERTY)) {
 this.maxRedirects = NumberUtils.parseNumber(
@@ -139,7 +140,7 @@ public void addClusterNode(RedisNode node) {
 }
 
 /**
- * @return
+ * @return this.
  */
 public RedisClusterConfiguration clusterNode(RedisNode node) {
 
@@ -148,14 +149,14 @@ public RedisClusterConfiguration clusterNode(RedisNode node) {
 }
 
 /**
- * @return
+ * @return max number of redirects to follow or {@literal null} if not set.
  */
 public Integer getMaxRedirects() {
 return maxRedirects != null && maxRedirects > Integer.MIN_VALUE ? maxRedirects : null;
 }
 
 /**
- * @param maxRedirects
+ * @param maxRedirects the max number of redirects to follow.
  */
 public void setMaxRedirects(int maxRedirects) {
 
@@ -164,9 +165,9 @@ public void setMaxRedirects(int maxRedirects) {
 }
 
 /**
- * @param host
- * @param port
- * @return
+ * @param host Redis cluster node host name or ip address.
+ * @param port Redis cluster node port.
+ * @return this.
  */
 public RedisClusterConfiguration clusterNode(String host, Integer port) {
 return clusterNode(new RedisNode(host, port));
@@ -180,7 +181,9 @@ private void appendClusterNodes(Set<String> hostAndPorts) {
 }
 
 /**
- * @return
+ * Get the {@link RedisPassword} defined.
+ *
+ * @return never {@literal null}.
  * @since 2.0
  */
 public RedisPassword getPassword() {
@@ -204,26 +207,24 @@ private RedisNode readHostAndPortFromString(String hostAndPort) {
 
 notNull(args, "HostAndPort need to be seperated by ':'.");
 isTrue(args.length == 2, "Host and Port String needs to specified as host:port");
-return new RedisNode(args[0], Integer.valueOf(args[1]).intValue());
+return new RedisNode(args[0], Integer.valueOf(args[1]));
 }
 
 /**
  * @param clusterHostAndPorts must not be {@literal null} or empty.
- * @param timeout
- * @param redirects
+ * @param redirects the max number of redirects to follow.
  * @param password can be {@literal null} or empty.
- * @return
+ * @return cluster config map with properties.
  */
-private static Map<String, Object> asMap(Collection<String> clusterHostAndPorts, long timeout, int redirects,
-String password) {
+private static Map<String, Object> asMap(Collection<String> clusterHostAndPorts, int redirects) {
 
 notNull(clusterHostAndPorts, "ClusterHostAndPorts must not be null!");
 
-Map<String, Object> map = new HashMap<String, Object>();
+Map<String, Object> map = new HashMap<>();
 map.put(REDIS_CLUSTER_NODES_CONFIG_PROPERTY, StringUtils.collectionToCommaDelimitedString(clusterHostAndPorts));
 
 if (redirects >= 0) {
-map.put(REDIS_CLUSTER_MAX_REDIRECTS_CONFIG_PROPERTY, Integer.valueOf(redirects));
+map.put(REDIS_CLUSTER_MAX_REDIRECTS_CONFIG_PROPERTY, redirects);
 }
 
 return map;

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

@@ -25,6 +25,8 @@
 import java.util.function.Function;
 
 import org.springframework.util.Assert;
+import org.springframework.util.ObjectUtils;
+import org.springframework.util.StringUtils;
 
 /**
  * Value object which may or may not contain a Redis password.
@@ -34,13 +36,14 @@
  * The password is stored as character array.
  *
  * @author Mark Paluch
+ * @author Christoph Strobl
  * @since 2.0
  */
 @RequiredArgsConstructor(access = AccessLevel.PRIVATE)
 @EqualsAndHashCode
 public class RedisPassword {
 
-private static final RedisPassword NONE = new RedisPassword(new char[0]);
+private static final RedisPassword NONE = new RedisPassword(new char[] {});
 
 private final char[] thePassword;
 
@@ -53,21 +56,21 @@ public class RedisPassword {
 public static RedisPassword of(String passwordAsString) {
 
 return Optional.ofNullable(passwordAsString) //
-.filter(it -> it.length() != 0) //
+.filter(StringUtils::hasText) //
 .map(it -> new RedisPassword(it.toCharArray())) //
 .orElseGet(RedisPassword::none);
 }
 
 /**
  * Create a {@link RedisPassword} from a {@code char} array.
  *
- * @param passwordAsChars the password as string.
+ * @param passwordAsChars the password as char array.
  * @return the {@link RedisPassword} for {@code passwordAsChars}.
  */
 public static RedisPassword of(char[] passwordAsChars) {
 
 return Optional.ofNullable(passwordAsChars) //
-.filter(it -> it.length != 0) //
+.filter(it -> !ObjectUtils.isEmpty(passwordAsChars)) //
 .map(it -> new RedisPassword(Arrays.copyOf(it, it.length))) //
 .orElseGet(RedisPassword::none);
 }
@@ -87,7 +90,7 @@ public static RedisPassword none() {
  * @return {@code true} if there is a password present, otherwise {@code false}
  */
 public boolean isPresent() {
-return thePassword.length != 0;
+return !ObjectUtils.isEmpty(thePassword);
 }
 
 /**
@@ -117,11 +120,7 @@ public <R> Optional<R> map(Function<char[], R> mapper) {
 
 Assert.notNull(mapper, "Mapper function must not be null!");
 
-if (isPresent()) {
-return Optional.ofNullable(mapper.apply(thePassword));
-}
-
-return Optional.empty();
+return toOptional().map(mapper);
 }
 
 /**
@@ -140,7 +139,8 @@ public Optional<char[]> toOptional() {
 return Optional.empty();
 }
 
-/* (non-Javadoc)
+/*
+ * (non-Javadoc)
  * @see java.lang.Object#toString()
  */
 @Override

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

@@ -54,7 +54,7 @@ public class RedisSentinelConfiguration {
  * Creates new {@link RedisSentinelConfiguration}.
  */
 public RedisSentinelConfiguration() {
-this(new MapPropertySource("RedisSentinelConfiguration", Collections.<String, Object> emptyMap()));
+this(new MapPropertySource("RedisSentinelConfiguration", Collections.emptyMap()));
 }
 
 /**
@@ -89,7 +89,7 @@ public RedisSentinelConfiguration(PropertySource<?> propertySource) {
 
 notNull(propertySource, "PropertySource must not be null!");
 
-this.sentinels = new LinkedHashSet<RedisNode>();
+this.sentinels = new LinkedHashSet<>();
 
 if (propertySource.containsProperty(REDIS_SENTINEL_MASTER_CONFIG_PROPERTY)) {
 this.setMaster(propertySource.getProperty(REDIS_SENTINEL_MASTER_CONFIG_PROPERTY).toString());
@@ -145,13 +145,7 @@ public void addSentinel(RedisNode sentinel) {
 public void setMaster(final String name) {
 
 notNull(name, "Name of sentinel master must not be null.");
-setMaster(new NamedNode() {
-
-@Override
-public String getName() {
-return name;
-}
-});
+setMaster(() -> name);
 }
 
 /**
@@ -168,16 +162,16 @@ public void setMaster(NamedNode master) {
 /**
  * Get the {@literal Sentinel} master node.
  *
- * @return
+ * @return get the master node.
  */
 public NamedNode getMaster() {
 return master;
 }
 
 /**
  * @see #setMaster(String)
- * @param master
- * @return
+ * @param master The master node name.
+ * @return this.
  */
 public RedisSentinelConfiguration master(String master) {
 this.setMaster(master);
@@ -186,8 +180,8 @@ public RedisSentinelConfiguration master(String master) {
 
 /**
  * @see #setMaster(NamedNode)
- * @param master
- * @return
+ * @param master the master node
+ * @return this.
  */
 public RedisSentinelConfiguration master(NamedNode master) {
 this.setMaster(master);
@@ -196,8 +190,8 @@ public RedisSentinelConfiguration master(NamedNode master) {
 
 /**
  * @see #addSentinel(RedisNode)
- * @param sentinel
- * @return
+ * @param sentinel the node to add as sentinel.
+ * @return this.
  */
 public RedisSentinelConfiguration sentinel(RedisNode sentinel) {
 this.addSentinel(sentinel);
@@ -206,9 +200,9 @@ public RedisSentinelConfiguration sentinel(RedisNode sentinel) {
 
 /**
  * @see #sentinel(RedisNode)
- * @param host
- * @param port
- * @return
+ * @param host redis sentinel node host name or ip.
+ * @param port redis sentinel port.
+ * @return this.
  */
 public RedisSentinelConfiguration sentinel(String host, Integer port) {
 return sentinel(new RedisNode(host, port));
@@ -222,7 +216,7 @@ private void appendSentinels(Set<String> hostAndPorts) {
 }
 
 /**
- * @return
+ * @return the initial db index.
  * @since 2.0
  */
 public int getDatabase() {
@@ -237,13 +231,13 @@ public int getDatabase() {
  */
 public void setDatabase(int index) {
 
-Assert.isTrue(index >= 0, "invalid DB index (a positive index required)");
+Assert.isTrue(index >= 0, () -> String.format("Invalid DB index '%s' (a positive index required)", index));
 
 this.database = index;
 }
 
 /**
- * @return
+ * @return never {@literal null}.
  * @since 2.0
  */
 public RedisPassword getPassword() {
@@ -273,14 +267,14 @@ private RedisNode readHostAndPortFromString(String hostAndPort) {
 /**
  * @param master must not be {@literal null} or empty.
  * @param sentinelHostAndPorts must not be {@literal null}.
- * @return
+ * @return configuration map.
  */
 private static Map<String, Object> asMap(String master, Set<String> sentinelHostAndPorts) {
 
 hasText(master, "Master address must not be null or empty!");
 notNull(sentinelHostAndPorts, "SentinelHostAndPorts must not be null!");
 
-Map<String, Object> map = new HashMap<String, Object>();
+Map<String, Object> map = new HashMap<>();
 map.put(REDIS_SENTINEL_MASTER_CONFIG_PROPERTY, master);
 map.put(REDIS_SENTINEL_NODES_CONFIG_PROPERTY, StringUtils.collectionToCommaDelimitedString(sentinelHostAndPorts));