[jboss-svn-commits] JBL Code SVN: r8086 - labs/jbossesb/trunk/product/core/listeners/src/org/jboss/soa/esb/listeners/message

[jboss-svn-commits at lists.jboss.org]

Author: tfennelly
Date: 2006-12-06 05:25:35 -0500 (Wed, 06 Dec 2006)
New Revision: 8086

Modified:
   labs/jbossesb/trunk/product/core/listeners/src/org/jboss/soa/esb/listeners/message/AbstractListener.java
Log:
added some more javadoc

Modified: labs/jbossesb/trunk/product/core/listeners/src/org/jboss/soa/esb/listeners/message/AbstractListener.java
===================================================================
--- labs/jbossesb/trunk/product/core/listeners/src/org/jboss/soa/esb/listeners/message/AbstractListener.java	2006-12-06 10:19:59 UTC (rev 8085)
+++ labs/jbossesb/trunk/product/core/listeners/src/org/jboss/soa/esb/listeners/message/AbstractListener.java	2006-12-06 10:25:35 UTC (rev 8086)
@@ -29,8 +29,14 @@
 import org.jboss.soa.esb.listeners.State;
 
 /**
- * Base class for listener implementations  which will be responsible for implementing some sort of
- * blocking receive whithin the run() method.
+ * Base class for listener implementations which will be responsible for implementing some sort of
+ * blocking receive whithin the {@link #listen()} method.
+ * <p/>
+ * Note that the {@link java.lang.Runnable#run()} method has been made final in this class.  This is to
+ * enable capture of Thread termination, graceful or otherwise, and to reflect the status change in the
+ * lifecycle state of the listener.
+ * <p/>
+ * The effective "run" method for implementations of this class is the {@link #listen()} method.
  * 
  * @author <a href="mailto:johan.kumps at telenet.be">Johan Kumps</a>
  *