diff options
Diffstat (limited to 'qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQMethodListener.java')
-rw-r--r-- | qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQMethodListener.java | 20 |
1 files changed, 7 insertions, 13 deletions
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQMethodListener.java b/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQMethodListener.java index 8cc9709c9c..3e7c67493d 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQMethodListener.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQMethodListener.java @@ -27,17 +27,11 @@ import org.apache.qpid.framing.AMQMethodBody; * AMQMethodListener is a listener that receives notifications of AMQP methods. The methods are packaged as events in * {@link AMQMethodEvent}. * - * <p/>An event listener may be associated with a particular context, usually an AMQP channel, and in addition to + * <p>An event listener may be associated with a particular context, usually an AMQP channel, and in addition to * receiving method events will be notified of errors on that context. This enables listeners to perform any clean * up that they need to do before the context is closed or retried. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities - * <tr><td> Accept notification of AMQP method events. <td> {@link AMQMethodEvent} - * <tr><td> Accept notification of errors on the event context. - * </table> - * - * @todo Document why the exception is passed to the error method. Is it so that the exception can be passed + * <p> + * TODO Document why the exception is passed to the error method. Is it so that the exception can be passed * from the event handling thread to another thread and rethown from there? It is unusual to pass exceptions as * method arguments, because they have their own mechanism for propagating through the call stack, so some * explanation ought to be provided. @@ -49,14 +43,14 @@ public interface AMQMethodListener * * @param evt The AMQP method event (contains the method and channel). * - * @return <tt>true</tt> if the handler processes the method frame, <tt>false<tt> otherwise. Note that this does + * @return true if the handler processes the method frame, false otherwise. Note that this does * not prohibit the method event being delivered to subsequent listeners but can be used to determine if * nobody has dealt with an incoming method frame. * - * @throws Exception if an error has occurred. This exception may be delivered to all registered listeners using + * @throws AMQException if an error has occurred. This exception may be delivered to all registered listeners using * the error() method (see below) allowing them to perform cleanup if necessary. - * - * @todo Consider narrowing the exception. + * <p> + * TODO Consider narrowing the exception. */ <B extends AMQMethodBody> boolean methodReceived(AMQMethodEvent<B> evt) throws AMQException; |