Commits

Anonymous committed 877ad75

Adding javadocs and code comments

git-svn-id: http://svn.opensymphony.com/svn/webwork/trunk@2543573baa09-0c28-0410-bef9-dab3c582ae83

  • Participants
  • Parent commits 84f27cf

Comments (0)

Files changed (3)

File src/java/com/opensymphony/webwork/sitemesh/FreeMarkerPageFilter.java

 import java.util.Locale;
 
 /**
+ *  Applies FreeMarker-based sitemesh decorators.
+ *
  * @author patrick
  */
 public class FreeMarkerPageFilter extends TemplatePageFilter {
     private static final Log LOG = LogFactory.getLog(FreeMarkerPageFilter.class);
 
+    /**
+     *  Applies the decorator, using the relevent contexts
+     * 
+     * @param page The page
+     * @param decorator The decorator
+     * @param req The servlet request
+     * @param res The servlet response
+     * @param servletContext The servlet context
+     * @param ctx The action context for this request, populated with the server state
+     */
     protected void applyDecorator(Page page, Decorator decorator,
                                   HttpServletRequest req, HttpServletResponse res,
                                   ServletContext servletContext, ActionContext ctx)

File src/java/com/opensymphony/webwork/sitemesh/TemplatePageFilter.java

 import java.io.IOException;
 
 /**
+ *  An abstract template page filter that sets up the proper contexts for
+ *  template processing.
+ * 
  * @author patrick
  */
 public abstract class TemplatePageFilter extends PageFilter {
         this.filterConfig = filterConfig;
     }
 
+    /**
+     *  Applies the decorator, using the relevent contexts
+     * 
+     * @param page The page
+     * @param decorator The decorator
+     * @param req The servlet request
+     * @param res The servlet response
+     * @param servletContext The servlet context
+     * @param ctx The action context for this request, populated with the server state
+     */
     protected abstract void applyDecorator(Page page, Decorator decorator,
                                   HttpServletRequest req, HttpServletResponse res,
                                   ServletContext servletContext, ActionContext ctx)
             throws ServletException, IOException;
     
+    /**
+     *  Applies the decorator, creating the relevent contexts and delegating to
+     *  the extended applyDecorator().
+     * 
+     * @param page The page
+     * @param decorator The decorator
+     * @param req The servlet request
+     * @param res The servlet response
+     */
     protected void applyDecorator(Page page, Decorator decorator,
                                   HttpServletRequest req, HttpServletResponse res)
             throws ServletException, IOException {
             }
         }
 
+        // delegate to the actual page decorator
         applyDecorator(page, decorator, req, res, servletContext, ctx);
-   }
+    }
 
-   
+    
+    /**
+     *  Gets the L18N encoding of the system.  The default is UTF-8.
+     */
     protected String getEncoding() {
         String encoding = (String) Configuration.get(WebWorkConstants.WEBWORK_I18N_ENCODING);
         if (encoding == null) {

File src/java/com/opensymphony/webwork/sitemesh/VelocityPageFilter.java

 
 
 /**
+ *  Applies Velocity-based decorators
+ * 
  * User: plightbo
  * Date: Aug 31, 2005
  * Time: 10:49:51 PM
 public class VelocityPageFilter extends TemplatePageFilter {
     private static final Log LOG = LogFactory.getLog(VelocityPageFilter.class);
 
-
+    /**
+     *  Applies the decorator, using the relevent contexts
+     * 
+     * @param page The page
+     * @param decorator The decorator
+     * @param req The servlet request
+     * @param res The servlet response
+     * @param servletContext The servlet context
+     * @param ctx The action context for this request, populated with the server state
+     */
     protected void applyDecorator(Page page, Decorator decorator,
                                   HttpServletRequest req, HttpServletResponse res,
                                   ServletContext servletContext, ActionContext ctx)