svn commit: r574257 - /myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/spring/PersistenceContextCloser.java

[sk...@apache.org]

Author: skitching
Date: Mon Sep 10 07:23:22 2007
New Revision: 574257

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

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

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/spring/PersistenceContextCloser.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/spring/PersistenceContextCloser.java?rev=574257&r1=574256&r2=574257&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/spring/PersistenceContextCloser.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/spring/PersistenceContextCloser.java Mon Sep 10 07:23:22 2007
@@ -22,6 +22,14 @@
 import org.apache.myfaces.orchestra.conversation.ConversationBindingEvent;
 import org.apache.myfaces.orchestra.conversation.ConversationBindingListener;
 
+/**
+ * A simple class to tidy up persistence contexts.
+ * <p>
+ * An instance of this class can be stored into the attributes of a specific
+ * Conversation object. Because it implements ConversationBindingListener, it
+ * receives a valueUnbound callback when the Conversation is terminated. It
+ * then closes the persistence context object associated with the Conversation. 
+ */
 public class PersistenceContextCloser implements ConversationBindingListener
 {
 	private final PersistenceContext persistenceContext;