diff --git a/src/main/java/org/springframework/data/redis/connection/RedisConnection.java b/src/main/java/org/springframework/data/redis/connection/RedisConnection.java index aa92feb900..e5ddcba127 100644 --- a/src/main/java/org/springframework/data/redis/connection/RedisConnection.java +++ b/src/main/java/org/springframework/data/redis/connection/RedisConnection.java @@ -20,21 +20,26 @@ import org.springframework.dao.DataAccessException; /** - * A connection to a Redis server. Acts as an common abstraction across various Redis client libraries (or drivers). - * Additionally performs exception translation between the underlying Redis client library and Spring DAO exceptions. + * A connection to a Redis server. + *

+ * The {@link RedisConnection} interface serves as a common abstraction across various Redis client libraries + * (or drivers). + *

+ * Additionally, performs exception translation between the underlying Redis client library and Spring DAO exceptions. * The methods follow as much as possible the Redis names and conventions. * * @author Costin Leau * @author Christoph Strobl * @author Mark Paluch * @author James Howe + * @author John Blum */ public interface RedisConnection extends RedisCommandsProvider, DefaultedRedisConnection, AutoCloseable { /** - * Closes (or quits) the connection. + * Closes or quits the connection. * - * @throws DataAccessException + * @throws DataAccessException if the {@link RedisConnection} could not be closed. */ @Override void close() throws DataAccessException; @@ -97,8 +102,9 @@ public interface RedisConnection extends RedisCommandsProvider, DefaultedRedisCo List closePipeline() throws RedisPipelineException; /** - * @return + * @return the {@link RedisSentinelConnection} when using Redis Sentinel. * @since 1.4 */ RedisSentinelConnection getSentinelConnection(); + }