Skip to content

Commit 424379b

Browse files
committed
Edit Javadoc in RedisConnection.
Closes spring-projects#2586
1 parent 5e21ed6 commit 424379b

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

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

+11-5
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,26 @@
2020
import org.springframework.dao.DataAccessException;
2121

2222
/**
23-
* A connection to a Redis server. Acts as an common abstraction across various Redis client libraries (or drivers).
24-
* Additionally performs exception translation between the underlying Redis client library and Spring DAO exceptions.
23+
* A connection to a Redis server.
24+
* <p>
25+
* The {@link RedisConnection} interface serves as a common abstraction across various Redis client libraries
26+
* (or drivers).
27+
* <p>
28+
* Additionally, performs exception translation between the underlying Redis client library and Spring DAO exceptions.
2529
* The methods follow as much as possible the Redis names and conventions.
2630
*
2731
* @author Costin Leau
2832
* @author Christoph Strobl
2933
* @author Mark Paluch
3034
* @author James Howe
35+
* @author John Blum
3136
*/
3237
public interface RedisConnection extends RedisCommandsProvider, DefaultedRedisConnection, AutoCloseable {
3338

3439
/**
35-
* Closes (or quits) the connection.
40+
* Closes or quits the connection.
3641
*
37-
* @throws DataAccessException
42+
* @throws DataAccessException if the {@link RedisConnection} could not be closed.
3843
*/
3944
@Override
4045
void close() throws DataAccessException;
@@ -97,8 +102,9 @@ public interface RedisConnection extends RedisCommandsProvider, DefaultedRedisCo
97102
List<Object> closePipeline() throws RedisPipelineException;
98103

99104
/**
100-
* @return
105+
* @return the {@link RedisSentinelConnection} when using Redis Sentinel.
101106
* @since 1.4
102107
*/
103108
RedisSentinelConnection getSentinelConnection();
109+
104110
}

0 commit comments

Comments
 (0)