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

[sk...@apache.org]

Author: skitching
Date: Fri Aug 17 02:51:53 2007
New Revision: 566986

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

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

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/CurrentConversationAdvice.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/CurrentConversationAdvice.java?view=diff&rev=566986&r1=566985&r2=566986
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/CurrentConversationAdvice.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/CurrentConversationAdvice.java Fri Aug 17 02:51:53 2007
@@ -24,6 +24,7 @@
 
 /**
  * <p>An advice which will be added to all conversation scoped beans.</p>
+ * 
  * <p>It will:
  * <ul>
  * <li>Maintain the {@link Conversation#getCurrentInstance()}</li>
@@ -38,6 +39,11 @@
  * that target bean. The result is that the real bean can call
  * Conversation.getCurrentInstance() and always receives a reference to the
  * conversation object that has been configured for it.</p>
+ * 
+ * <p>In addition, on return from the target bean method, this object
+ * checks whether the conversation has been marked as invalid. If so (and
+ * the conversation is not in use by something further up the call stack)
+ * then destroy the conversation object.</p>
  */
 public class CurrentConversationAdvice implements MethodInterceptor
 {