[jboss-remoting-commits] JBoss Remoting SVN: r3455 - remoting3/trunk/core/src/main/java/org/jboss/cx/remoting/core.

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

Author: david.lloyd at jboss.com
Date: 2008-02-18 21:40:46 -0500 (Mon, 18 Feb 2008)
New Revision: 3455

Modified:
   remoting3/trunk/core/src/main/java/org/jboss/cx/remoting/core/QueueExecutor.java
Log:
javadoc update

Modified: remoting3/trunk/core/src/main/java/org/jboss/cx/remoting/core/QueueExecutor.java
===================================================================
--- remoting3/trunk/core/src/main/java/org/jboss/cx/remoting/core/QueueExecutor.java	2008-02-19 02:39:22 UTC (rev 3454)
+++ remoting3/trunk/core/src/main/java/org/jboss/cx/remoting/core/QueueExecutor.java	2008-02-19 02:40:46 UTC (rev 3455)
@@ -6,7 +6,10 @@
 import org.jboss.cx.remoting.log.Logger;
 
 /**
- *
+ * An executor designed to run all submitted tasks in the current thread.  The queue is run continuously
+ * until the {@code shutdown()} method is invoked.  Jobs may be submitted to the queue from any thread.
+ * Only one thread should invoke the {@code runQueue()} method, which will run until the executor is
+ * shut down.
  */
 public final class QueueExecutor implements Executor {
     private static final Logger log = Logger.getLogger(QueueExecutor.class);