svn commit: r567033 - /myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/Conversation.java

[sk...@apache.org]

Author: skitching
Date: Fri Aug 17 05:09:39 2007
New Revision: 567033

URL: http://svn.apache.org/viewvc?view=rev&rev=567033
Log:
Add javadoc only.

Modified:
    myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/Conversation.java

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/Conversation.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/Conversation.java?view=diff&rev=567033&r1=567032&r2=567033
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/Conversation.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/Conversation.java Fri Aug 17 05:09:39 2007
@@ -27,21 +27,16 @@
 import java.util.TreeMap;
 
 /**
- * <p/>
- * The conversation object
- * </p>
- * <p/>
  * The container for all beans managed by this conversation.
- * </p>
- * <p/>
+ * <p>
  * There is a (not yet configureable) timeout which is responsible to destory
  * the conversation if it has not been accessed.
  * </p>
- * <p/>
+ * <p>
  * Beans implementing the {@link ConversationBindingListener} will receive a message
  * when removed from (e.g. during destroy) or added to the conversation.
  * </p>
- * <p/>
+ * <p>
  * There are various ways how to get access to the conversation:
  * <ul>
  * <li>{@link Conversation#getCurrentInstance} if you are within a conversation</li>
@@ -129,7 +124,7 @@
 	}
 
 	/**
-	 * assert the conversation is valid
+	 * assert the conversation is valid.
 	 */
 	protected void checkValid()
 	{
@@ -157,7 +152,7 @@
 
 	/**
 	 * <p>Invalidate/End the conversation</p>
-	 * <p/>
+	 * <p>
 	 * If you are within a conversation (the conversation is active) this
 	 * will just queue the destroy to the next possible time.
 	 * A conversation is active if you are within a method of one of the
@@ -329,7 +324,12 @@
 	}
 
 	/**
-	 * increase one to the "conversation active" counter
+	 * Increase one to the "conversation active" counter. 
+	 * 
+	 * This is called when a method is invoked on a bean that is within this conversation.
+	 * When the method returns, leaveConversation is invoked. The result is that the count
+	 * is greater than zero whenever there is a bean belonging to this conversation on
+	 * the callstack.
 	 */
 	void enterConversation()
 	{