Commits

Anonymous committed c6549e3

Comments (0)

Files changed (1)

src/java/com/opensymphony/webwork/dispatcher/WebWorkResultSupport.java

 package com.opensymphony.webwork.dispatcher;
 
 import com.opensymphony.webwork.WebWorkStatics;
-
 import com.opensymphony.xwork.ActionContext;
 import com.opensymphony.xwork.ActionInvocation;
 import com.opensymphony.xwork.Result;
 /**
  * A base class for all WebWork action execution results.
  * The "location" param is the default parameter, meaning the most common usage of this result would be:
- *
+ * <p/>
  * This class provides two common parameters for any subclass:
  * <ul>
- *  <li>location - the location to go to after execution (could be a jsp page or another action).
- *      It can be parsed as per the rules definied in the
- *      {@link TextParseUtil#translateVariables(java.lang.String, com.opensymphony.xwork.util.OgnlValueStack) translateVariables}
- *      method</li>
- *  <li>parse - true by default. If set to false, the location param will not be parsed for expressions</li>
+ * <li>location - the location to go to after execution (could be a jsp page or another action).
+ * It can be parsed as per the rules definied in the
+ * {@link TextParseUtil#translateVariables(java.lang.String, com.opensymphony.xwork.util.OgnlValueStack) translateVariables}
+ * method</li>
+ * <li>parse - true by default. If set to false, the location param will not be parsed for expressions</li>
  * </ul>
- *
+ * <p/>
  * In the xwork.xml configuration file, these would be included as:
- *
+ * <p/>
  * <pre>
  *  &lt;result name="success" type="redirect"&gt;
  *      &lt;param name="<b>location</b>"&gt;foo.jsp&lt;/param&gt;
  *  &lt;/result&gt;</pre>
- *
+ * <p/>
  * or
- *
+ * <p/>
  * <pre>
  *  &lt;result name="success" type="redirect" &gt;
  *      &lt;param name="<b>location</b>"&gt;foo.jsp&lt;/param&gt;
  *      &lt;param name="<b>parse</b>"&gt;false&lt;/param&gt;
  *  &lt;/result&gt;</pre>
- *
+ * <p/>
  * or when using the default parameter feature
- *
+ * <p/>
  * <pre>
  *  &lt;result name="success" type="redirect"&gt;<b>foo.jsp</b>&lt;/result&gt;</pre>
- *
+ * <p/>
  * You should subclass this class if you're interested in adding more parameters or functionality
  * to your Result. If you do subclass this class you will need to
  * override {@link #doExecute(String, ActionInvocation)}.<p>
- *
+ * <p/>
  * Any custom result can be defined in xwork.xml as:
- *
+ * <p/>
  * <pre>
  *  &lt;result-types&gt;
  *      ...
  *      &lt;result-type name="myresult" class="com.foo.MyResult" /&gt;
  *  &lt;/result-types&gt;</pre>
- *
+ * <p/>
  * Please see the {@link com.opensymphony.xwork.Result} class for more info on Results in general.
  *
- * @see com.opensymphony.xwork.Result
  * @author Jason Carreira
  * @author Bill Lynch (docs)
+ * @see com.opensymphony.xwork.Result
  */
 public abstract class WebWorkResultSupport implements Result, WebWorkStatics {
     //~ Static fields/initializers /////////////////////////////////////////////
      * The location can contain OGNL expressions which will be evaulated if the <tt>parse</tt>
      * parameter is set to <tt>true</tt>.
      *
-     * @see #setParse(boolean)
      * @param location the location to go to after action execution.
+     * @see #setParse(boolean)
      */
     public void setLocation(String location) {
         this.location = location;
 
     /**
      * Set parse to <tt>true</tt> to indicate that the location should be parsed as an OGNL expression. This
-     * is set to <tt>false</tt> by default.
+     * is set to <tt>true</tt> by default.
      * 
      * @param parse <tt>true</tt> if the location parameter is an OGNL expression, <tt>false</tt> otherwise.
      */
      * custom logic for result handling.
      *
      * @param finalLocation the location (jsp page, action, etc) to go to.
-     * @param invocation the execution state of the action.
+     * @param invocation    the execution state of the action.
      * @throws Exception if an error occurs while executing the result.
      */
     protected abstract void doExecute(String finalLocation, ActionInvocation invocation) throws Exception;