svn commit: r653732 - in /forrest/trunk/main/java/org/apache/forrest/locationmap: AbstractWrappingModule.java LocationMapModule.java

[thorsten]

Author: thorsten
Date: Tue May  6 03:11:26 2008
New Revision: 653732

URL: http://svn.apache.org/viewvc?rev=653732&view=rev
Log:
Adding javadoc.

Modified:
    
forrest/trunk/main/java/org/apache/forrest/locationmap/AbstractWrappingModule.java
    
forrest/trunk/main/java/org/apache/forrest/locationmap/LocationMapModule.java

Modified: 
forrest/trunk/main/java/org/apache/forrest/locationmap/AbstractWrappingModule.java
URL: 
http://svn.apache.org/viewvc/forrest/trunk/main/java/org/apache/forrest/locationmap/AbstractWrappingModule.java?rev=653732&r1=653731&r2=653732&view=diff
==============================================================================
--- 
forrest/trunk/main/java/org/apache/forrest/locationmap/AbstractWrappingModule.java
 (original)
+++ 
forrest/trunk/main/java/org/apache/forrest/locationmap/AbstractWrappingModule.java
 Tue May  6 03:11:26 2008
@@ -31,7 +31,15 @@
 import org.apache.avalon.framework.service.Serviceable;
 
 import org.apache.cocoon.components.modules.input.InputModule;
-
+/**
+ * Wrapper module that loads an input module for all 
+ * <code>component-instance</code> defined in the configuration.
+ * <p>
+ * After we created an instance we will check for the different possible
+ * implementations of some interfaces (such as e.g. [EMAIL PROTECTED] 
LogEnabled}) and
+ * invoke the corresponding methods 
+ * (e.g. [EMAIL PROTECTED] 
LogEnabled#enableLogging(org.apache.avalon.framework.logger.Logger)}.
+ */
 public abstract class AbstractWrappingModule extends AbstractLogEnabled
     implements InputModule, Configurable, Serviceable, Disposable {
 

Modified: 
forrest/trunk/main/java/org/apache/forrest/locationmap/LocationMapModule.java
URL: 
http://svn.apache.org/viewvc/forrest/trunk/main/java/org/apache/forrest/locationmap/LocationMapModule.java?rev=653732&r1=653731&r2=653732&view=diff
==============================================================================
--- 
forrest/trunk/main/java/org/apache/forrest/locationmap/LocationMapModule.java 
(original)
+++ 
forrest/trunk/main/java/org/apache/forrest/locationmap/LocationMapModule.java 
Tue May  6 03:11:26 2008
@@ -44,6 +44,23 @@
 
 /**
  * Resolves a request against a LocationMap.
+ * <p>
+ * The locationmap module works as any other [EMAIL PROTECTED] InputModule}.
+ * It acts as a location resolver where you can configure a series
+ * of fallbacks.
+ * <p>
+ * It can be seen as a reduced sitemap with the only concern of 
+ * resolving locations strings to the final location.
+ * <p> 
+ * This module is configured via a sitemap similar DSL which looks
+ * something like:
+ * &lt;locationmap&gt;<br>
+ *  &lt;components/&gt;<br>
+ *  &lt;locator/&gt;<br>
+ *  &lt;/locationmap&gt;<br>
+ *  <p>
+ *  You can use the same actions and selectors like you can use 
+ *  in any othe sitemap.
  */
 public class LocationMapModule extends AbstractLogEnabled
     implements InputModule, Serviceable, Configurable, Disposable, ThreadSafe {