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

[sk...@apache.org]

Author: skitching
Date: Thu Oct  4 07:56:20 2007
New Revision: 581939

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

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

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationAspects.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationAspects.java?rev=581939&r1=581938&r2=581939&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationAspects.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationAspects.java Thu Oct  4 07:56:20 2007
@@ -22,16 +22,26 @@
 import java.util.Map;
 
 /**
- * <p>
  * Maintains a list of aspects the system might attach to a conversation instance.
- * </p>
  * <p>
- * An aspect can be:
+ * Aspects are a way of extending the functionality of a class without modifying it;
+ * it acts something like the "decorator" pattern, but with many different decorator
+ * classes being supported at one.
+ * <p>
+ * In the simplest form, an Aspect can be attached to a Conversation simply as a "marker"
+ * to indicate whether the conversation should be treated in a certain way or not.
+ * <p>
+ * In more sophisticated form, an Aspect can provide an API. Code that wants to
+ * manipulate some "conversation-related" property can query the conversation for the
+ * appropriate Aspect object, then invoke the aspect api to read or write the
+ * Conversation instance via an implementation that is isolated from both the caller
+ * and the Conversation.
+ * <p>
+ * Examples of aspects that can be attached to a conversation are:
  * <ul>
  *     <li>Timeout handling</li>
  *     <li>Flash Scope handling</li>
  * </ul>
- * </p>
  */
 public class ConversationAspects
 {