svn commit: r1661947 - in /sling/trunk/contrib/extensions/validation: api/src/main/java/org/apache/sling/validation/api/ core/src/main/java/org/apache/sling/validation/impl/validators/

[kwin]

Author: kwin
Date: Tue Feb 24 13:42:39 2015
New Revision: 1661947

URL: http://svn.apache.org/r1661947
Log:
clarified that the valuemap given to a validate method is never null

Modified:
    
sling/trunk/contrib/extensions/validation/api/src/main/java/org/apache/sling/validation/api/ParameterizedValidator.java
    
sling/trunk/contrib/extensions/validation/api/src/main/java/org/apache/sling/validation/api/Validator.java
    
sling/trunk/contrib/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/validators/RegexValidator.java

Modified: 
sling/trunk/contrib/extensions/validation/api/src/main/java/org/apache/sling/validation/api/ParameterizedValidator.java
URL: 
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/validation/api/src/main/java/org/apache/sling/validation/api/ParameterizedValidator.java?rev=1661947&r1=1661946&r2=1661947&view=diff
==============================================================================
--- 
sling/trunk/contrib/extensions/validation/api/src/main/java/org/apache/sling/validation/api/ParameterizedValidator.java
 (original)
+++ 
sling/trunk/contrib/extensions/validation/api/src/main/java/org/apache/sling/validation/api/ParameterizedValidator.java
 Tue Feb 24 13:42:39 2015
@@ -26,10 +26,22 @@ import org.apache.sling.api.resource.Val
  */
 public interface ParameterizedValidator {
 
+    /**
+     * 
+     * @return the validator
+     */
     public abstract Validator<?> getValidator();
 
+    /**
+     * 
+     * @return the parameterization of the validator (never {@code null}, but 
might be empty map)
+     */
     public abstract ValueMap getParameters();
 
+    /**
+     * 
+     * @return the type of the validator (i.e. the type of the data it can 
handle)
+     */
     public abstract Class<?> getType();
 
 }
\ No newline at end of file

Modified: 
sling/trunk/contrib/extensions/validation/api/src/main/java/org/apache/sling/validation/api/Validator.java
URL: 
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/validation/api/src/main/java/org/apache/sling/validation/api/Validator.java?rev=1661947&r1=1661946&r2=1661947&view=diff
==============================================================================
--- 
sling/trunk/contrib/extensions/validation/api/src/main/java/org/apache/sling/validation/api/Validator.java
 (original)
+++ 
sling/trunk/contrib/extensions/validation/api/src/main/java/org/apache/sling/validation/api/Validator.java
 Tue Feb 24 13:42:39 2015
@@ -62,7 +62,7 @@ public interface Validator <T> {
      *
      * @param data the data to validate (primary property), never {@code null}.
      * @param valueMap all properties (only used for validations considering 
multiple properties), never {@code null}.
-     * @param arguments the parameterization of the validator. Might be {@code 
null} in case no arguments were given.
+     * @param arguments the parameterization of the validator. Never {@code 
null} but might be the empty map.
      * @return validation error message if validation was not successful, 
{@code null} otherwise. In case an empty string is returned a generic 
validation error message is used.
      * @throws 
org.apache.sling.validation.api.exceptions.SlingValidationException if some 
expected arguments are missing from the arguments map
      */

Modified: 
sling/trunk/contrib/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/validators/RegexValidator.java
URL: 
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/validators/RegexValidator.java?rev=1661947&r1=1661946&r2=1661947&view=diff
==============================================================================
--- 
sling/trunk/contrib/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/validators/RegexValidator.java
 (original)
+++ 
sling/trunk/contrib/extensions/validation/core/src/main/java/org/apache/sling/validation/impl/validators/RegexValidator.java
 Tue Feb 24 13:42:39 2015
@@ -40,9 +40,6 @@ public class RegexValidator implements V
     @Override
     public String validate(String data, ValueMap valueMap, ValueMap arguments)
             throws SlingValidationException {
-        if (arguments == null) {
-            throw new SlingValidationException("Cannot perform data validation 
with null parameters");
-        }
         String regex = arguments.get(REGEX_PARAM, "");
         if (StringUtils.isEmpty(regex)) {
             throw new SlingValidationException("Mandatory " + REGEX_PARAM + " 
is missing from the arguments map.");