You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@sling.apache.org by kw...@apache.org on 2017/02/24 12:13:09 UTC

svn commit: r1784270 - /sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/DefaultValidationResult.java

Author: kwin
Date: Fri Feb 24 12:13:09 2017
New Revision: 1784270

URL: http://svn.apache.org/viewvc?rev=1784270&view=rev
Log:
improve javadoc

Modified:
    sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/DefaultValidationResult.java

Modified: sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/DefaultValidationResult.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/DefaultValidationResult.java?rev=1784270&r1=1784269&r2=1784270&view=diff
==============================================================================
--- sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/DefaultValidationResult.java (original)
+++ sling/trunk/bundles/extensions/validation/api/src/main/java/org/apache/sling/validation/spi/DefaultValidationResult.java Fri Feb 24 12:13:09 2017
@@ -28,6 +28,10 @@ import javax.annotation.Nonnull;
 import org.apache.sling.validation.ValidationFailure;
 import org.apache.sling.validation.ValidationResult;
 
+/**
+ * Default implementation of {@link ValidationResult} wrapping a list of {@link ValidationFailure}s.
+ *
+ */
 public class DefaultValidationResult implements ValidationResult {
 
     private final boolean isValid;
@@ -67,5 +71,8 @@ public class DefaultValidationResult imp
         return failures;
     }
 
+    /**
+     * Used to indicated a valid result. Use this instead of instantiating your own {@link DefaultValidationResult}.
+     */
     public static final @Nonnull DefaultValidationResult VALID = new DefaultValidationResult(true);
 }