[jboss-cvs] JBoss Messaging SVN: r4396 - trunk/src/main/org/jboss/messaging/util.

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

Author: clebert.suconic at jboss.com
Date: 2008-06-05 14:47:39 -0400 (Thu, 05 Jun 2008)
New Revision: 4396

Modified:
   trunk/src/main/org/jboss/messaging/util/VariableLatch.java
Log:
javadoc tweak

Modified: trunk/src/main/org/jboss/messaging/util/VariableLatch.java
===================================================================
--- trunk/src/main/org/jboss/messaging/util/VariableLatch.java	2008-06-05 16:41:33 UTC (rev 4395)
+++ trunk/src/main/org/jboss/messaging/util/VariableLatch.java	2008-06-05 18:47:39 UTC (rev 4396)
@@ -32,8 +32,11 @@
  * 
  * The idea is, instead of providing each user specific Latch/Synchronization, java.util.concurrent provides the framework for reuses, based on an AtomicInteger (getState())
  * 
- * On JBossMessaging we have the requirement of increment and decrement a counter until the user fires a ready event (commit). At that point we just act as a regular countDown
+ * On JBossMessaging we have the requirement of increment and decrement a counter until the user fires a ready event (commit). At that point we just act as a regular countDown.
  * 
+ * Note: This latch is reusable. Once it reaches zero, you can call up again, and reuse it on further waits.
+ *       For example: prepareTransaction will wait for the current completions, and further adds will be called on the latch. Later on when commit is called you can reuse the same latch.
+ * 
  * @author Clebert Suconic
  * */
 public class VariableLatch