Commits

rainerh  committed aa56b2d

added javadoc to methods, refine class level javadoc
o ported fix from xwork 1.2 branch

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

  • Participants
  • Parent commits 24f4a30

Comments (0)

Files changed (1)

File src/java/com/opensymphony/xwork2/validator/ValidatorFileParser.java

 import java.io.InputStream;
 
 /**
- * Parse the validation file. (eg. MyAction-validation.xml, MyAction-actionAlias-validation.xml)
- * to return a List of ValidatorConfig encapsulating the validator information.
+ * This class serves 2 purpose :
+ * <ul>
+ * <li>
+ * Parse the validation config file. (eg. MyAction-validation.xml, MyAction-actionAlias-validation.xml)
+  * to return a List of ValidatorConfig encapsulating the validator information.
+ * </li>
+ * <li>
+ * Parse the validator definition file, (eg. validators.xml) that defines the {@link Validator}s
+ * registered with XWork.
+ * </li>
+ * </ul>
  *
  * @author Jason Carreira
  * @author James House
  */
 public interface ValidatorFileParser {
     /**
-     * Parse resource for a list of ValidatorConfig objects.
+     * Parse resource for a list of ValidatorConfig objects (configuring which validator(s) are
+     * being applied to a particular field etc.)
      *
      * @param is input stream to the resource
      * @param resourceName file name of the resource
     List<ValidatorConfig> parseActionValidatorConfigs(ValidatorFactory validatorFactory, InputStream is, String resourceName);
 
     /**
-     * Parses validator definitions
+     * Parses validator definitions (register various validators with XWork).
      *
      * @param is The input stream
      * @param resourceName The location of the input stream