svn commit: r565535 - in /myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter: FrameworkAdapter.java FrameworkAdapterInterface.java

[sk...@apache.org]

Author: skitching
Date: Mon Aug 13 14:30:21 2007
New Revision: 565535

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

Modified:
    myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapter.java
    myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapterInterface.java

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapter.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapter.java?view=diff&rev=565535&r1=565534&r2=565535
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapter.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapter.java Mon Aug 13 14:30:21 2007
@@ -23,7 +23,13 @@
 package org.apache.myfaces.orchestra.frameworkAdapter;
 
 /**
- * Provides access to the FrameworkAdapter so
+ * Provides a static method for returning the singleton FrameworkAdapterInterface, which allows Orchestra to
+ * support MVC frameworks other than JSF.
+ * <p>
+ * This class can be configured to return any implementation of FrameworkAdapterInterface that is desired,
+ * simply by calling setFrameworkAdapter before any Orchestra code calls getInstance on this class. If no
+ * configuration is done then getInstance defaults to returning a FrameworkAdapterInterface which supports
+ * JSF.
  */
 public final class FrameworkAdapter
 {

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapterInterface.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapterInterface.java?view=diff&rev=565535&r1=565534&r2=565535
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapterInterface.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapterInterface.java Mon Aug 13 14:30:21 2007
@@ -25,7 +25,11 @@
 import java.io.IOException;
 
 /**
- * The interface a framework has to provide to make use of the conversation scope
+ * An interface that provides access to all the data necessary for Orchestra to work while isolating Orchestra
+ * from the actual MVC system being used. This allows Orchestra to support frameworks other than JSF.
+ * <p>
+ * Orchestra locates a concrete implementation of this class by using the FrameworkAdapter class, which supports
+ * configuration of the actual underlying object returned.
  */
 public interface FrameworkAdapterInterface
 {