Polishing.

Refine Javadoc.

See #3218

Author: mp911de

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

@@ -53,12 +53,12 @@ public class RedisClusterConfiguration implements RedisConfiguration, ClusterCon
 	private @Nullable String username = null;
 
 	/**
-	 * Creates a new, default {@link RedisClusterConfiguration}.
+	 * Creates a new, default {@code RedisClusterConfiguration}.
 	 */
 	public RedisClusterConfiguration() {}
 
 	/**
-	 * Creates a new {@link RedisClusterConfiguration} for given {@link String hostPort} combinations.
+	 * Creates a new {@code RedisClusterConfiguration} for given {@link String hostPort} combinations.
 	 *
 	 * <pre class="code">
 	 * clusterHostAndPorts[0] = 127.0.0.1:23679
@@ -74,7 +74,7 @@ public RedisClusterConfiguration(Collection<String> clusterNodes) {
 	}
 
 	/**
-	 * Creates a new {@link RedisClusterConfiguration} looking up configuration values from the given
+	 * Creates a new {@code RedisClusterConfiguration} looking up configuration values from the given
 	 * {@link PropertySource}.
 	 *
 	 * <pre class="code">
@@ -83,7 +83,7 @@ public RedisClusterConfiguration(Collection<String> clusterNodes) {
 	 * </pre>
 	 *
 	 * @param propertySource must not be {@literal null}.
-	 * @return a new {@link RedisClusterConfiguration} configured from the given {@link PropertySource}.
+	 * @return a new {@code RedisClusterConfiguration} configured from the given {@link PropertySource}.
 	 * @since 3.3
 	 */
 	public static RedisClusterConfiguration of(PropertySource<?> propertySource) {

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

@@ -27,7 +27,7 @@
 
 /**
  * Marker interface for configuration classes related to Redis connection setup. As the setup scenarios are quite
- * diverse instead of struggling with unifying those, {@link RedisConfiguration} provides means to identify
+ * diverse instead of struggling with unifying those, {@code RedisConfiguration} provides means to identify
  * configurations for the individual purposes.
  *
  * @author Christoph Strobl
@@ -38,11 +38,11 @@
 public interface RedisConfiguration {
 
 	/**
-	 * Get the configured database index if the current {@link RedisConfiguration} is
+	 * Get the configured database index if the current {@code RedisConfiguration} is
 	 * {@link #isDatabaseIndexAware(RedisConfiguration) database aware} or evaluate and return the value of the given
 	 * {@link Supplier}.
 	 *
-	 * @param other a {@code Supplier} whose result is returned if given {@link RedisConfiguration} is not
+	 * @param other a {@code Supplier} whose result is returned if given {@code RedisConfiguration} is not
 	 *          {@link #isDatabaseIndexAware(RedisConfiguration) database aware}.
 	 * @return never {@literal null}.
 	 * @throws IllegalArgumentException if {@code other} is {@literal null}.
@@ -52,11 +52,11 @@ default Integer getDatabaseOrElse(Supplier<Integer> other) {
 	}
 
 	/**
-	 * Get the configured {@link RedisPassword} if the current {@link RedisConfiguration} is
+	 * Get the configured {@link RedisPassword} if the current {@code RedisConfiguration} is
 	 * {@link #isAuthenticationAware(RedisConfiguration) password aware} or evaluate and return the value of the given
 	 * {@link Supplier}.
 	 *
-	 * @param other a {@code Supplier} whose result is returned if given {@link RedisConfiguration} is not
+	 * @param other a {@code Supplier} whose result is returned if given {@code RedisConfiguration} is not
 	 *          {@link #isAuthenticationAware(RedisConfiguration) password aware}.
 	 * @return never {@literal null}.
 	 * @throws IllegalArgumentException if {@code other} is {@literal null}.
@@ -67,7 +67,7 @@ default RedisPassword getPasswordOrElse(Supplier<RedisPassword> other) {
 
 	/**
 	 * @param configuration can be {@literal null}.
-	 * @return {@code true} if given {@link RedisConfiguration} is instance of {@link WithPassword}.
+	 * @return {@code true} if given {@code RedisConfiguration} is instance of {@link WithPassword}.
 	 */
 	@Contract("null -> false")
 	static boolean isAuthenticationAware(@Nullable RedisConfiguration configuration) {
@@ -76,7 +76,7 @@ static boolean isAuthenticationAware(@Nullable RedisConfiguration configuration)
 
 	/**
 	 * @param configuration can be {@literal null}.
-	 * @return {@code true} if given {@link RedisConfiguration} is instance of {@link WithDatabaseIndex}.
+	 * @return {@code true} if given {@code RedisConfiguration} is instance of {@link WithDatabaseIndex}.
 	 */
 	@Contract("null -> false")
 	static boolean isDatabaseIndexAware(@Nullable RedisConfiguration configuration) {
@@ -85,7 +85,7 @@ static boolean isDatabaseIndexAware(@Nullable RedisConfiguration configuration)
 
 	/**
 	 * @param configuration can be {@literal null}.
-	 * @return {@code true} if given {@link RedisConfiguration} is instance of {@link SentinelConfiguration}.
+	 * @return {@code true} if given {@code RedisConfiguration} is instance of {@link SentinelConfiguration}.
 	 */
 	@Contract("null -> false")
 	static boolean isSentinelConfiguration(@Nullable RedisConfiguration configuration) {
@@ -94,7 +94,7 @@ static boolean isSentinelConfiguration(@Nullable RedisConfiguration configuratio
 
 	/**
 	 * @param configuration can be {@literal null}.
-	 * @return {@code true} if given {@link RedisConfiguration} is instance of {@link WithHostAndPort}.
+	 * @return {@code true} if given {@code RedisConfiguration} is instance of {@link WithHostAndPort}.
 	 * @since 2.1.6
 	 */
 	@Contract("null -> false")
@@ -104,7 +104,7 @@ static boolean isHostAndPortAware(@Nullable RedisConfiguration configuration) {
 
 	/**
 	 * @param configuration can be {@literal null}.
-	 * @return {@code true} if given {@link RedisConfiguration} is instance of {@link ClusterConfiguration}.
+	 * @return {@code true} if given {@code RedisConfiguration} is instance of {@link ClusterConfiguration}.
 	 */
 	@Contract("null -> false")
 	static boolean isClusterConfiguration(@Nullable RedisConfiguration configuration) {
@@ -113,7 +113,7 @@ static boolean isClusterConfiguration(@Nullable RedisConfiguration configuration
 
 	/**
 	 * @param configuration can be {@literal null}.
-	 * @return {@code true} if given {@link RedisConfiguration} is instance of {@link StaticMasterReplicaConfiguration}.
+	 * @return {@code true} if given {@code RedisConfiguration} is instance of {@link StaticMasterReplicaConfiguration}.
 	 */
 	@Contract("null -> false")
 	static boolean isStaticMasterReplicaConfiguration(@Nullable RedisConfiguration configuration) {
@@ -122,7 +122,7 @@ static boolean isStaticMasterReplicaConfiguration(@Nullable RedisConfiguration c
 
 	/**
 	 * @param configuration can be {@literal null}.
-	 * @return {@code true} if given {@link RedisConfiguration} is instance of {@link DomainSocketConfiguration}.
+	 * @return {@code true} if given {@code RedisConfiguration} is instance of {@link DomainSocketConfiguration}.
 	 */
 	@Contract("null -> false")
 	static boolean isDomainSocketConfiguration(@Nullable RedisConfiguration configuration) {
@@ -131,7 +131,7 @@ static boolean isDomainSocketConfiguration(@Nullable RedisConfiguration configur
 
 	/**
 	 * @param configuration can be {@literal null}.
-	 * @param other a {@code Supplier} whose result is returned if given {@link RedisConfiguration} is not
+	 * @param other a {@code Supplier} whose result is returned if given {@code RedisConfiguration} is not
 	 *          {@link #isDatabaseIndexAware(RedisConfiguration) database aware}.
 	 * @return never {@literal null}.
 	 * @throws IllegalArgumentException if {@code other} is {@literal null}.
@@ -144,7 +144,7 @@ static Integer getDatabaseOrElse(@Nullable RedisConfiguration configuration, Sup
 
 	/**
 	 * @param configuration can be {@literal null}.
-	 * @param other a {@code Supplier} whose result is returned if given {@link RedisConfiguration} is not
+	 * @param other a {@code Supplier} whose result is returned if given {@code RedisConfiguration} is not
 	 *          {@link #isAuthenticationAware(RedisConfiguration) password aware}.
 	 * @return can be {@literal null}.
 	 * @throws IllegalArgumentException if {@code other} is {@literal null}.
@@ -158,7 +158,7 @@ static Integer getDatabaseOrElse(@Nullable RedisConfiguration configuration, Sup
 
 	/**
 	 * @param configuration can be {@literal null}.
-	 * @param other a {@code Supplier} whose result is returned if given {@link RedisConfiguration} is not
+	 * @param other a {@code Supplier} whose result is returned if given {@code RedisConfiguration} is not
 	 *          {@link #isAuthenticationAware(RedisConfiguration) password aware}.
 	 * @return never {@literal null}.
 	 * @throws IllegalArgumentException if {@code other} is {@literal null}.
@@ -171,7 +171,7 @@ static RedisPassword getPasswordOrElse(@Nullable RedisConfiguration configuratio
 
 	/**
 	 * @param configuration can be {@literal null}.
-	 * @param other a {@code Supplier} whose result is returned if given {@link RedisConfiguration} is not
+	 * @param other a {@code Supplier} whose result is returned if given {@code RedisConfiguration} is not
 	 *          {@link #isHostAndPortAware(RedisConfiguration) port aware}.
 	 * @return never {@literal null}.
 	 * @throws IllegalArgumentException if {@code other} is {@literal null}.
@@ -185,7 +185,7 @@ static int getPortOrElse(@Nullable RedisConfiguration configuration, IntSupplier
 
 	/**
 	 * @param configuration can be {@literal null}.
-	 * @param other a {@code Supplier} whose result is returned if given {@link RedisConfiguration} is not
+	 * @param other a {@code Supplier} whose result is returned if given {@code RedisConfiguration} is not
 	 *          {@link #isHostAndPortAware(RedisConfiguration) host aware}.
 	 * @return never {@literal null}.
 	 * @throws IllegalArgumentException if {@code other} is {@literal null}.
@@ -198,7 +198,7 @@ static String getHostOrElse(@Nullable RedisConfiguration configuration, Supplier
 	}
 
 	/**
-	 * {@link RedisConfiguration} part suitable for configurations that may use authentication when connecting.
+	 * {@code RedisConfiguration} part suitable for configurations that may use authentication when connecting.
 	 *
 	 * @author Christoph Strobl
 	 * @author Mark Paluch
@@ -255,7 +255,7 @@ default void setPassword(char @Nullable[] password) {
 	}
 
 	/**
-	 * {@link RedisConfiguration} part suitable for configurations that may use authentication when connecting.
+	 * {@code RedisConfiguration} part suitable for configurations that may use authentication when connecting.
 	 *
 	 * @author Christoph Strobl
 	 * @since 2.1
@@ -265,7 +265,7 @@ interface WithPassword extends WithAuthentication {
 	}
 
 	/**
-	 * {@link RedisConfiguration} part suitable for configurations that use a specific database.
+	 * {@code RedisConfiguration} part suitable for configurations that use a specific database.
 	 *
 	 * @author Christoph Strobl
 	 * @since 2.1
@@ -288,7 +288,7 @@ interface WithDatabaseIndex {
 	}
 
 	/**
-	 * {@link RedisConfiguration} part suitable for configurations that use host/port combinations for connecting.
+	 * {@code RedisConfiguration} part suitable for configurations that use host/port combinations for connecting.
 	 *
 	 * @author Christoph Strobl
 	 * @since 2.1
@@ -323,7 +323,7 @@ interface WithHostAndPort {
 	}
 
 	/**
-	 * {@link RedisConfiguration} part suitable for configurations that use native domain sockets for connecting.
+	 * {@code RedisConfiguration} part suitable for configurations that use native domain sockets for connecting.
 	 *
 	 * @author Christoph Strobl
 	 * @since 2.1

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

@@ -68,13 +68,13 @@ public class RedisSentinelConfiguration implements RedisConfiguration, SentinelC
 	private @Nullable String sentinelUsername = null;
 
 	/**
-	 * Creates a new, default {@link RedisSentinelConfiguration}.
+	 * Creates a new, default {@code RedisSentinelConfiguration}.
 	 */
 	public RedisSentinelConfiguration() {
 	}
 
 	/**
-	 * Creates a new {@link RedisSentinelConfiguration} for given {@link String hostPort} combinations.
+	 * Creates a new {@code RedisSentinelConfiguration} for given {@link String hostPort} combinations.
 	 *
 	 * <pre class="code">
 	 * sentinelHostAndPorts[0] = 127.0.0.1:23679
@@ -97,10 +97,10 @@ public RedisSentinelConfiguration(String master, Set<String> sentinelHostAndPort
 	}
 
 	/**
-	 * Construct a new {@link RedisSentinelConfiguration} from the given {@link PropertySource}.
+	 * Construct a new {@code RedisSentinelConfiguration} from the given {@link PropertySource}.
 	 *
 	 * @param propertySource must not be {@literal null}.
-	 * @return a new {@link RedisSentinelConfiguration} configured from the given {@link PropertySource}.
+	 * @return a new {@code RedisSentinelConfiguration} configured from the given {@link PropertySource}.
 	 * @since 3.3
 	 */
 	public static RedisSentinelConfiguration of(PropertySource<?> propertySource) {

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

@@ -38,12 +38,12 @@ public class RedisSocketConfiguration implements RedisConfiguration, DomainSocke
 	private RedisPassword password = RedisPassword.none();
 
 	/**
-	 * Create a new default {@link RedisSocketConfiguration}.
+	 * Create a new default {@code RedisSocketConfiguration}.
 	 */
 	public RedisSocketConfiguration() {}
 
 	/**
-	 * Create a new {@link RedisSocketConfiguration} given {@code socket}.
+	 * Create a new {@code RedisSocketConfiguration} given {@code socket}.
 	 *
 	 * @param socket must not be {@literal null} or empty.
 	 */

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

@@ -47,12 +47,12 @@ public class RedisStandaloneConfiguration
 	private @Nullable String username = null;
 
 	/**
-	 * Create a new default {@link RedisStandaloneConfiguration}.
+	 * Create a new default {@code RedisStandaloneConfiguration}.
 	 */
 	public RedisStandaloneConfiguration() {}
 
 	/**
-	 * Create a new {@link RedisStandaloneConfiguration} given {@code hostName}.
+	 * Create a new {@code RedisStandaloneConfiguration} given {@code hostName}.
 	 *
 	 * @param hostName must not be {@literal null} or empty.
 	 */
@@ -61,7 +61,7 @@ public RedisStandaloneConfiguration(String hostName) {
 	}
 
 	/**
-	 * Create a new {@link RedisStandaloneConfiguration} given {@code hostName} and {@code port}.
+	 * Create a new {@code RedisStandaloneConfiguration} given {@code hostName} and {@code port}.
 	 *
 	 * @param hostName must not be {@literal null} or empty.
 	 * @param port a valid TCP port (1-65535).

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

@@ -26,9 +26,11 @@
 
 /**
  * Configuration class used for setting up {@link RedisConnection} via {@link RedisConnectionFactory} using the provided
- * Master / Replica configuration to nodes know to not change address. Eg. when connecting to
- * <a href="https://aws.amazon.com/documentation/elasticache/">AWS ElastiCache with Read Replicas</a>. <br/>
- * Please also note that a Master/Replica connection cannot be used for Pub/Sub operations.
+ * Master / Replica configuration to nodes know to not change address. Useful when connecting to
+ * <a href="https://aws.amazon.com/documentation/elasticache/">AWS ElastiCache with Read Replicas</a>.
+ * <p>
+ * A Master/Replica connection cannot be used for Pub/Sub operations as Pub/Sub messages are not broadcasted across
+ * replicas. Pub/Sub broadcasting is only available using {@link RedisClusterConfiguration Redis Cluster}.
  *
  * @author Mark Paluch
  * @author Christoph Strobl
@@ -52,7 +54,7 @@ public class RedisStaticMasterReplicaConfiguration implements RedisConfiguration
 	public RedisStaticMasterReplicaConfiguration() {}
 
 	/**
-	 * Create a new {@link StaticMasterReplicaConfiguration} given {@code hostName}.
+	 * Create a new {@code StaticMasterReplicaConfiguration} given {@code hostName}.
 	 *
 	 * @param hostName must not be {@literal null} or empty.
 	 */
@@ -61,7 +63,7 @@ public RedisStaticMasterReplicaConfiguration(String hostName) {
 	}
 
 	/**
-	 * Create a new {@link StaticMasterReplicaConfiguration} given {@code hostName} and {@code port}.
+	 * Create a new {@code StaticMasterReplicaConfiguration} given {@code hostName} and {@code port}.
 	 *
 	 * @param hostName must not be {@literal null} or empty.
 	 * @param port a valid TCP port (1-65535).
@@ -98,7 +100,7 @@ private void addNode(RedisStandaloneConfiguration node) {
 	 * Add a {@link RedisStandaloneConfiguration node} to the list of nodes given {@code hostName}.
 	 *
 	 * @param hostName must not be {@literal null} or empty.
-	 * @return {@code this} {@link StaticMasterReplicaConfiguration}.
+	 * @return {@code this} {@code StaticMasterReplicaConfiguration}.
 	 */
 	public RedisStaticMasterReplicaConfiguration node(String hostName) {
 		return node(hostName, DEFAULT_PORT);
@@ -109,7 +111,7 @@ public RedisStaticMasterReplicaConfiguration node(String hostName) {
 	 *
 	 * @param hostName must not be {@literal null} or empty.
 	 * @param port a valid TCP port (1-65535).
-	 * @return {@code this} {@link StaticMasterReplicaConfiguration}.
+	 * @return {@code this} {@code StaticMasterReplicaConfiguration}.
 	 */
 	public RedisStaticMasterReplicaConfiguration node(String hostName, int port) {