svn commit: r581893 - in /myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation: ConversationContext.java jsf/JsfConversationMessager.java

[sk...@apache.org]

Author: skitching
Date: Thu Oct  4 06:19:50 2007
New Revision: 581893

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

Modified:
    myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationContext.java
    myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/jsf/JsfConversationMessager.java

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationContext.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationContext.java?rev=581893&r1=581892&r2=581893&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationContext.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationContext.java Thu Oct  4 06:19:50 2007
@@ -210,9 +210,10 @@
 	}
 
 	/**
-	 * iterates the conversations
+	 * Iterates over all the conversations in this context.
 	 *
-	 * @return a copy of the conversation list
+	 * @return An iterator over a copy of the conversation list. It is safe to remove objects from
+	 * the conversation list while iterating, as the iterator refers to a different collection.
 	 */
 	public Iterator iterateConversations()
 	{

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/jsf/JsfConversationMessager.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/jsf/JsfConversationMessager.java?rev=581893&r1=581892&r2=581893&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/jsf/JsfConversationMessager.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/jsf/JsfConversationMessager.java Thu Oct  4 06:19:50 2007
@@ -29,6 +29,10 @@
 /**
  * Inform the user about some anomalies by displaying the problems as standard JSF messages.
  * <p>
+ * This class just provides some default behaviour; if you don't like it then implement your
+ * own version of this class and configure your alternative as the standard "Conversation Messager"
+ * instead. See the documentation on interface ConversationMessager for details.
+ * <p>
  * As required by the ConversationMessager interface, all methods on this class are thread-safe.
  */
 public class JsfConversationMessager extends ConversationMessager