Anonymous avatar Anonymous committed 17d8289

Docs improvements

git-svn-id: http://svn.opensymphony.com/svn/xwork/trunk@348 e221344d-f017-0410-9bd5-d282ab1896d7

Comments (0)

Files changed (1)

src/java/com/opensymphony/xwork/validator/ValidationInterceptor.java

 
 
 /**
- * ValidationInterceptor
- * <p/>
- * Created : Jan 19, 2003 3:56:42 PM
+ * Validates an action. This interceptor extends the {@link AroundInterceptor} and implements only the
+ * {@link AroundInterceptor#before(com.opensymphony.xwork.ActionInvocation)} method. This class
+ * simply class the {@link ActionValidatorManager#validate(java.lang.Object, java.lang.String)} method
+ * with the given Action and its context.
  *
  * @author Jason Carreira
  */
 public class ValidationInterceptor extends AroundInterceptor {
-    //~ Methods ////////////////////////////////////////////////////////////////
 
+    /**
+     * Does nothing in this implementation.
+     */
     protected void after(ActionInvocation dispatcher, String result) throws Exception {
     }
 
+    /**
+     * Gets the current action and its context and calls
+     * {@link ActionValidatorManager#validate(java.lang.Object, java.lang.String)}.
+     *
+     * @param invocation the execution state of the Action.
+     * @throws Exception if an error occurs validating the action.
+     */
     protected void before(ActionInvocation invocation) throws Exception {
         Action action = invocation.getAction();
         String context = invocation.getProxy().getActionName();
 
         if (log.isDebugEnabled()) {
-            log.debug("Validating " + invocation.getProxy().getNamespace() + "/" + invocation.getProxy().getActionName() + ".");
+            log.debug("Validating "
+                    + invocation.getProxy().getNamespace() + "/" + invocation.getProxy().getActionName() + ".");
         }
 
         ActionValidatorManager.validate(action, context);
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.