Tidy Javadoc

Author: rob-bygrave

validator/src/main/java/io/avaje/validation/ConstraintViolation.java

@@ -10,17 +10,21 @@ public class ConstraintViolation {
   private final String propertyName;
   private final String message;
 
+  /**
+   * Create the ConstraintViolation with the given path, property and message.
+   */
   public ConstraintViolation(String path, String propertyName, String message) {
     this.path = path;
     this.propertyName = propertyName;
     this.message = message;
   }
 
-  /** Return the path that this violation occurred for */
+  /** Return the path for this constraint violation */
   public String path() {
     return path;
   }
 
+  /** Return the property name for this constraint violation */
   public String propertyName() {
     return propertyName;
   }
@@ -32,7 +36,6 @@ public String message() {
 
   @Override
   public String toString() {
-
     return message;
   }
 }

validator/src/main/java/io/avaje/validation/ConstraintViolationException.java

@@ -2,14 +2,19 @@
 
 import java.util.Set;
 
+/**
+ * Exception holding a set of constraint violations.
+ */
 public final class ConstraintViolationException extends RuntimeException {
 
   private final Set<ConstraintViolation> violations;
 
+  /** Create with the given constraint violations */
   public ConstraintViolationException(Set<ConstraintViolation> violations) {
     this.violations = violations;
   }
 
+  /** Return the constraint violations. */
   public Set<ConstraintViolation> violations() {
     return violations;
   }

validator/src/main/java/io/avaje/validation/Validator.java

@@ -52,15 +52,13 @@ interface Builder {
 
     /**
      * Add ResourceBundle for error message interpolation
-     *
-     * @param bundleName the name of the bundleFiles
      */
     Builder addResourceBundles(ResourceBundle... bundle);
 
     /** Set Default Locale for this validator, if not set, will use Locale.getDefault() */
     Builder setDefaultLocale(Locale defaultLocale);
 
-    /** Adds an additional Locales for this validator */
+    /** Adds additional Locales for this validator */
     Builder addLocales(Locale... locales);
 
     /** Add a AdapterBuilder which provides a ValidationAdapter to use for the given type. */

validator/src/main/java/io/avaje/validation/adapter/ValidationAdapter.java

@@ -14,6 +14,7 @@ default boolean validate(T value, ValidationRequest req) {
     return validate(value, req, null);
   }
 
+  @SuppressWarnings("unchecked")
   default ValidationAdapter<T> list(ValidationContext ctx, Class<?> clazz) {
     final var after = ctx.<Object>adapter(clazz);
     return (value, req, propertyName) -> {
@@ -24,6 +25,7 @@ default ValidationAdapter<T> list(ValidationContext ctx, Class<?> clazz) {
     };
   }
 
+  @SuppressWarnings("unchecked")
   default ValidationAdapter<T> map(ValidationContext ctx, Class<?> clazz) {
     final var after = ctx.<Object>adapter(clazz);
     return (value, req, propertyName) -> {

validator/src/main/java/io/avaje/validation/adapter/ValidationContext.java

@@ -4,8 +4,9 @@
 import java.lang.reflect.Type;
 import java.util.Map;
 
-import io.avaje.validation.adapter.ValidationContext.Message;
-
+/**
+ * Context available when validation adapters are being created.
+ */
 public interface ValidationContext {
 
   /**

validator/src/main/java/io/avaje/validation/adapter/ValidationRequest.java

@@ -1,13 +1,31 @@
 package io.avaje.validation.adapter;
 
+/**
+ * A validation request.
+ */
 public interface ValidationRequest {
 
-  void addViolation(ValidationContext.Message msg, String propertyName);
+  /**
+   * Add a constraint violation for the given property.
+   *
+   * @param message The message
+   * @param propertyName The property that failed the constraint
+   */
+  void addViolation(ValidationContext.Message message, String propertyName);
 
+  /**
+   * Push the nested path.
+   */
   void pushPath(String path);
 
+  /**
+   * Pop the nested path.
+   */
   void popPath();
 
+  /**
+   * Throw ConstraintViolationException if there are violations for this request.
+   */
   void throwWithViolations();
 
 }