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

[sk...@apache.org]

Author: skitching
Date: Tue Feb 26 01:50:12 2008
New Revision: 631144

URL: http://svn.apache.org/viewvc?rev=631144&view=rev
Log:
Documentation updates only.

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

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationUtils.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationUtils.java?rev=631144&r1=631143&r2=631144&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationUtils.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationUtils.java Tue Feb 26 01:50:12 2008
@@ -35,10 +35,13 @@
     /**
      * End and restart the given conversation.
      * <p>
-     * In contrast to {@link Conversation#invalidateAndRestart()} this
-     * method returns a new instance of the "controller bean" for the given conversation.
+     * This method tries to return a bean whose name is the same as the
+     * name of the specified conversation. If no such bean is defined, then
+     * null is returned.
      * <p>
-     * The "controller bean" is the one you configured in your dependency injection framework.
+     * Note that the return value is quite different from the
+     * {@link Conversation#invalidateAndRestart()} method, which returns
+     * an instance of the most recently invoked conversation-scoped bean.
      */
     public static Object invalidateAndRestart(Conversation conversation)
     {
@@ -104,8 +107,16 @@
     /**
      * End and restart the current conversation.
      * <p>
-     * In contrast to {@link #invalidateAndRestart(Conversation)} this
-     * method returns a new instance of the "current bean".
+     * The "current conversation" is the conversation associated with the
+     * most-recently-invoked conversation-scoped bean.
+     * <p>
+     * The returned object is a new instance of the most-recently-invoked
+     * conversation-scope bean.
+     * <p>
+     * This method is generally expected to be called from a conversation-scoped
+     * bean, in which case the conversation that is invalidated is the one in
+     * which the calling bean instance lives, and the returned object is the
+     * instance that will replace the calling object. 
      */
     public static Object invalidateAndRestartCurrent()
     {