merge bug19575 into v1_5

Author: Matthias Radestock

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

@@ -100,17 +100,17 @@ public AMQCommand(Method method, AMQContentHeader contentHeader, byte[] body) {
         setContentBody(body);
     }
 
-    /** Public API - Retrieve the Command's method. */
+    /** Public API - {@inheritDoc} */
     public Method getMethod() {
         return _method;
     }
 
-    /** Public API - Retrieve the Command's ContentHeader. */
+    /** Public API - {@inheritDoc} */
     public ContentHeader getContentHeader() {
         return _contentHeader;
     }
 
-    /** Public API - Retrieve the Command's content body. */
+    /** Public API - {@inheritDoc} */
     public byte[] getContentBody() {
         if (_bodyN != null) {
             coalesceContentBody();

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

@@ -144,18 +144,22 @@ public void ensureIsOpen()
     /** Hosts retrieved from the connection.open-ok */
     public Address[] _knownHosts;
 
+    /** {@inheritDoc} */
     public String getHost() {
         return _frameHandler.getHost();
     }
 
+    /** {@inheritDoc} */
     public int getPort() {
         return _frameHandler.getPort();
     }
 
+    /** {@inheritDoc} */
     public ConnectionParameters getParameters() {
         return _params;
     }
 
+    /** {@inheritDoc} */
     public Address[] getKnownHosts() {
         return _knownHosts;
     }
@@ -211,9 +215,7 @@ public void checkPreconditions() {
         AMQCommand.checkEmptyContentBodyFrameSize();
     }
 
-    /**
-     * @see com.rabbitmq.client.Connection#getChannelMax()
-     */
+    /** {@inheritDoc} */
     public int getChannelMax() {
         return _channelManager.getChannelMax();
     }
@@ -225,9 +227,7 @@ public void setChannelMax(int value) {
         _channelManager.setChannelMax(value);
     }
 
-    /**
-     * @see com.rabbitmq.client.Connection#getFrameMax()
-     */
+    /** {@inheritDoc} */
     public int getFrameMax() {
         return _frameMax;
     }
@@ -240,9 +240,7 @@ public void setFrameMax(int value) {
         _frameMax = value;
     }
 
-    /**
-     * @see com.rabbitmq.client.Connection#getHeartbeat()
-     */
+    /** {@inheritDoc} */
     public int getHeartbeat() {
         return _heartbeat;
     }
@@ -270,18 +268,13 @@ public ExceptionHandler getExceptionHandler() {
         return _exceptionHandler;
     }
 
-    /**
-     * Public API - creates a new channel using the specified channel number.
-     */
-
+    /** Public API - {@inheritDoc} */
     public Channel createChannel(int channelNumber) throws IOException {
         ensureIsOpen();
         return _channelManager.createChannel(this, channelNumber);
     }
 
-    /**
-     * Public API - creates a new channel using an internally allocated channel number.
-     */
+    /** Public API - {@inheritDoc} */
     public Channel createChannel() throws IOException {
         ensureIsOpen();
         return _channelManager.createChannel(this);
@@ -617,45 +610,53 @@ public ShutdownSignalException shutdown(Object reason,
         return sse;
     }
 
+    /** Public API - {@inheritDoc} */
     public void close()
         throws IOException
     {
         close(-1);
     }
 
+    /** Public API - {@inheritDoc} */
     public void close(int timeout)
         throws IOException
     {
         close(AMQP.REPLY_SUCCESS, "OK", timeout);
     }
 
+    /** Public API - {@inheritDoc} */
     public void close(int closeCode, String closeMessage)
         throws IOException
     {
         close(closeCode, closeMessage, -1);
     }
 
+    /** Public API - {@inheritDoc} */
     public void close(int closeCode, String closeMessage, int timeout)
         throws IOException
     {
         close(closeCode, closeMessage, true, null, timeout, false);
     }
 
+    /** Public API - {@inheritDoc} */
     public void abort()
     {
         abort(-1);
     }
 
+    /** Public API - {@inheritDoc} */
     public void abort(int closeCode, String closeMessage)
     {
        abort(closeCode, closeMessage, -1);
     }
 
+    /** Public API - {@inheritDoc} */
     public void abort(int timeout)
     {
         abort(AMQP.REPLY_SUCCESS, "OK", timeout);
     }
 
+    /** Public API - {@inheritDoc} */
     public void abort(int closeCode, String closeMessage, int timeout)
     {
         try {
@@ -664,7 +665,13 @@ public void abort(int closeCode, String closeMessage, int timeout)
             Utility.emptyStatement();
         }
     }
-    
+
+    /** 
+     * Protected API - Delegates to {@link
+     * #close(int,String,boolean,Throwable,int,boolean) the
+     * six-argument close method}, passing 0 for the timeout, and
+     * false for the abort flag.
+     */
     public void close(int closeCode,
                       String closeMessage,
                       boolean initiatedByApplication,

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

@@ -63,7 +63,7 @@ public void writeTo(DataOutputStream out, long bodySize) throws IOException {
     }
 
     /**
-     *  Private API - Autogenerated reader for this header
+     * Private API - Autogenerated reader for this header
      */
     public abstract void readPropertiesFrom(ContentHeaderPropertyReader reader) throws IOException;
 
@@ -72,9 +72,7 @@ public void writeTo(DataOutputStream out, long bodySize) throws IOException {
      */
     public abstract void writePropertiesTo(ContentHeaderPropertyWriter writer) throws IOException;
 
-    /**
-     * Public API - Debugging hook
-     */
+    /** Public API - {@inheritDoc} */
     public void appendPropertyDebugStringTo(StringBuffer acc) {
         acc.append("(?)");
     }