Fixed various inconsistencies in the Connection

and Channel javadocs. Implementation methods now
import javadocs from corresponding interfaces.

Author: Hubert Plociniczak

src/com/rabbitmq/client/Channel.java

@@ -70,7 +70,8 @@ public interface Channel extends ShutdownNotifier{
     Connection getConnection();
 
     /**
-     * Close this channel with the default close code and message.
+     * Close this channel with the {@link com.rabbitmq.client.AMQP#REPLY_SUCCESS} close code
+     * and message 'OK'.
      * 
      * @throws java.io.IOException if an error is encountered
      */

src/com/rabbitmq/client/Connection.java

@@ -122,10 +122,10 @@ public interface Connection extends ShutdownNotifier { // rename to AMQPConnecti
 
     /**
      * Close this connection and all its channels
-     * with the default close code and message.
+     * with the {@link com.rabbitmq.client.AMQP#REPLY_SUCCESS} close code
+     * and message 'OK'.
      *
-     * This method will wait infinitely for all the close operations to
-     * complete.
+     * Waits for all the close operations to complete.
      *
      * @throws IOException if an I/O problem is encountered
      */
@@ -134,8 +134,7 @@ public interface Connection extends ShutdownNotifier { // rename to AMQPConnecti
     /**
      * Close this connection and all its channels.
      *
-     * This method will wait infinitely for all the close operations to
-     * complete.
+     * Waits for all the close operations to complete.
      *
      * @param closeCode the close code (See under "Reply Codes" in the AMQP specification)
      * @param closeMessage a message indicating the reason for closing the connection
@@ -145,11 +144,12 @@ public interface Connection extends ShutdownNotifier { // rename to AMQPConnecti
 
     /**
      * Close this connection and all its channels
-     * with the default close code and message.
-     *
-     * This method will wait with the given timeout for all the close
-     * operations to complete. If timeout is reached then socket is forced
-     * to close.
+     * with the {@link com.rabbitmq.client.AMQP#REPLY_SUCCESS} close code
+     * and message 'OK'.
+     * 
+     * This method behaves in a similar way as {@link #close()}, with the only difference
+     * that it waits with a provided timeout for all the close operations to
+     * complete. When timeout is reached the socket is forced to close.
      * 
      * @param timeout timeout (in milliseconds) for completing all the close-related
      * operations, use -1 for infinity
@@ -160,9 +160,8 @@ public interface Connection extends ShutdownNotifier { // rename to AMQPConnecti
     /**
      * Close this connection and all its channels.
      *
-     * This method will wait with the given timeout for all the close
-     * operations to complete. If timeout is reached then socket is forced
-     * to close.
+     * Waits with the given timeout for all the close operations to complete.
+     * When timeout is reached the socket is forced to close.
      * 
      * @param closeCode the close code (See under "Reply Codes" in the AMQP specification)
      * @param closeMessage a message indicating the reason for closing the connection
@@ -174,18 +173,19 @@ public interface Connection extends ShutdownNotifier { // rename to AMQPConnecti
 
     /**
      * Abort this connection and all its channels
-     * with the default code and message.
+     * with the {@link com.rabbitmq.client.AMQP#REPLY_SUCCESS} close code
+     * and message 'OK'.
      *
-     * This method will force the connection to close. It will silently discard
-     * any exceptions encountered in close operations.
+     * Forces the connection to close.
+     * Any encountered exceptions in the close operations are silently discarded.
      */
     void abort();
 
     /**
      * Abort this connection and all its channels.
      *
-     * This method will force the connection to close. It will silently discard
-     * any exceptions encountered in close operations.
+     * Forces the connection to close and waits for all the close operations to complete.
+     * Any encountered exceptions in the close operations are silently discarded.
      * 
      * @param closeCode the close code (See under "Reply Codes" in the AMQP specification)
      * @param closeMessage a message indicating the reason for closing the connection
@@ -194,11 +194,12 @@ public interface Connection extends ShutdownNotifier { // rename to AMQPConnecti
 
     /**
      * Abort this connection and all its channels
-     * with the default close code and message.
+     * with the {@link com.rabbitmq.client.AMQP#REPLY_SUCCESS} close code
+     * and message 'OK'.
      *
-     * This method behaves in a similar way as abort(), with the only difference
-     * that it will wait with a provided timeout for all the close operations to
-     * complete. If timeout is reached socket is forced to close.
+     * This method behaves in a similar way as {@link #abort()}, with the only difference
+     * that it waits with a provided timeout for all the close operations to
+     * complete. When timeout is reached the socket is forced to close.
      *
      * @param timeout timeout (in milliseconds) for completing all the close-related
      * operations, use -1 for infinity
@@ -208,9 +209,10 @@ public interface Connection extends ShutdownNotifier { // rename to AMQPConnecti
     /**
      * Abort this connection and all its channels.
      *
-     * This method behaves in a similar way as abort(), with the only difference
-     * that it will wait with a provided timeout for all the close operations to
-     * complete. If timeout is reached socket is forced to close.
+     * Forces the connection to close and waits with the given timeout
+     * for all the close operations to complete. When timeout is reached
+     * the socket is forced to close.
+     * Any encountered exceptions in the close operations are silently discarded.
      *
      * @param closeCode the close code (See under "Reply Codes" in the AMQP specification)
      * @param closeMessage a message indicating the reason for closing the connection

src/com/rabbitmq/client/impl/AMQConnection.java

@@ -62,7 +62,7 @@
  * int ticket = ch1.accessRequest(realmName);
  * </pre>
  */
-public class AMQConnection extends ShutdownNotifierComponent implements Connection{
+public class AMQConnection extends ShutdownNotifierComponent implements Connection {
     /** Timeout used while waiting for AMQP handshaking to complete (milliseconds) */
     public static final int HANDSHAKE_TIMEOUT = 10000;
 
@@ -617,75 +617,45 @@ public void shutdown(Object reason,
         _channelManager.handleSignal(_shutdownCause);
     }
 
-    /**
-     * Public API - Close this connection and all its channels.
-     */
     public void close()
         throws IOException
     {
         close(-1);
     }
 
-    /**
-     * Public API - Close this connection and all its channels
-     * with a given timeout.
-     */
     public void close(int timeout)
         throws IOException
     {
-        close(AMQP.REPLY_SUCCESS, "Goodbye", timeout);
+        close(AMQP.REPLY_SUCCESS, "OK", timeout);
     }
-    
-    /**
-     * Public API - Close this connection and all its channels
-     * with a given close code and message.
-     */
+
     public void close(int closeCode, String closeMessage)
         throws IOException
     {
         close(closeCode, closeMessage, -1);
     }
 
-    /**
-     * Public API - Close this connection and all its channels
-     * with a given close code, message and timeout.
-     */
     public void close(int closeCode, String closeMessage, int timeout)
         throws IOException
     {
         close(closeCode, closeMessage, true, null, timeout, false);
     }
 
-    /**
-     * Public API - Abort this connection and all its channels.
-     */
     public void abort()
     {
         abort(-1);
     }
 
-    /**
-     * Public API - Abort this connection and all its channels
-     * with a given close code and message.
-     */
     public void abort(int closeCode, String closeMessage)
     {
        abort(closeCode, closeMessage, -1);
     }
 
-    /**
-     * Public API - Abort this connection and all its channels
-     * with a given timeout.
-     */
     public void abort(int timeout)
     {
-        abort(AMQP.REPLY_SUCCESS, "Goodbye", timeout);
+        abort(AMQP.REPLY_SUCCESS, "OK", timeout);
     }
-    
-    /**
-     * Public API - Abort this connection and all its channels
-     * with a given close code, message and timeout.
-     */
+
     public void abort(int closeCode, String closeMessage, int timeout)
     {
         try {
@@ -705,7 +675,9 @@ public void close(int closeCode,
     }
 
     /**
-     * Protected API - Close this connection with the given code, message and source.
+     * Protected API - Close this connection with the given code, message, source
+     * and timeout value for all the close operations to complete.
+     * Specifies if any encountered exceptions should be ignored.
      */
     public void close(int closeCode,
                       String closeMessage,

src/com/rabbitmq/client/impl/ChannelN.java

@@ -249,19 +249,12 @@ public void releaseChannelNumber() {
         }
     }
 
-
-    /**
-     * Public API - Close this channel with the default close code and message.
-     */
     public void close()
         throws IOException
     {
-        close(AMQP.REPLY_SUCCESS, "Goodbye");
+        close(AMQP.REPLY_SUCCESS, "OK");
     }
 
-    /**
-     * Public API - Close this channel.
-     */
     public void close(int closeCode, String closeMessage)
         throws IOException
     {

test/src/com/rabbitmq/examples/SpammyTopicProducer.java

@@ -92,8 +92,8 @@ public static void main(String[] args) {
                 }
             }
 
-            //ch.close(200, "Closing the channel");
-            //conn.close(200, "Closing the connection");
+            //ch.close();
+            //conn.close();
         } catch (Exception e) {
             System.err.println("Main thread caught exception: " + e);
             e.printStackTrace();