Documentation

lettuce/src/main/java/com/lambdaworks/redis/BaseRedisAsyncConnection.java

@@ -31,9 +31,6 @@ public interface BaseRedisAsyncConnection<K, V> extends Closeable {
 
     RedisFuture<String> quit();
 
-    @Override
-    void close();
-
     String digest(V script);
 
     RedisFuture<String> discard();
@@ -48,6 +45,16 @@ public interface BaseRedisAsyncConnection<K, V> extends Closeable {
 
     RedisFuture<Long> waitForReplication(int replicas, long timeout);
 
+    /**
+     * Close the connection. The connection will become not usable anymore as soon as this method was called.
+     */
+    @Override
+    void close();
+
+    /**
+     * 
+     * @return true if the connection is open (connected and not closed).
+     */
     boolean isOpen();
 
 }

lettuce/src/main/java/com/lambdaworks/redis/BaseRedisConnection.java

@@ -31,9 +31,6 @@ public interface BaseRedisConnection<K, V> extends Closeable {
 
     String quit();
 
-    @Override
-    void close();
-
     String digest(V script);
 
     String discard();
@@ -48,6 +45,16 @@ public interface BaseRedisConnection<K, V> extends Closeable {
 
     Long waitForReplication(int replicas, long timeout);
 
+    /**
+     * Close the connection. The connection will become not usable anymore as soon as this method was called.
+     */
+    @Override
+    void close();
+
+    /**
+     * 
+     * @return true if the connection is open (connected and not closed).
+     */
     boolean isOpen();
 
 }

lettuce/src/main/java/com/lambdaworks/redis/Connections.java

@@ -5,10 +5,18 @@
 import java.util.concurrent.ExecutionException;
 
 /**
+ * Utility for checking a connection's state.
+ * 
  * @author <a href="mailto:[email protected]">Mark Paluch</a>
  * @since 14.05.14 22:05
  */
 public class Connections {
+
+    /**
+     * 
+     * @param connection
+     * @return true if the connection is valid (ping works).
+     */
     public final static boolean isValid(Object connection) {
 
         checkNotNull(connection, "connection must not be null");
@@ -39,6 +47,11 @@ public final static boolean isValid(Object connection) {
         throw new IllegalArgumentException("Connection class " + connection.getClass() + " not supported");
     }
 
+    /**
+     * 
+     * @param connection
+     * @return true if the connection is open.
+     */
     public final static boolean isOpen(Object connection) {
 
         checkNotNull(connection, "connection must not be null");
@@ -55,6 +68,11 @@ public final static boolean isOpen(Object connection) {
         throw new IllegalArgumentException("Connection class " + connection.getClass() + " not supported");
     }
 
+    /**
+     * Closes a connection.
+     * 
+     * @param connection
+     */
     public static void close(Object connection) {
 
         checkNotNull(connection, "connection must not be null");