doc(filter): add javadoc on filter operation

Ouest-France · Dec 21, 2023 · c028524 · c028524
1 parent 6d86f45
commit c028524
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 2 deletions.
diff --git a/src/main/java/fr/ouestfrance/querydsl/FilterOperation.java b/src/main/java/fr/ouestfrance/querydsl/FilterOperation.java
@@ -5,40 +5,70 @@
 import fr.ouestfrance.querydsl.service.validators.impl.ComparableValidator;
 import fr.ouestfrance.querydsl.service.validators.impl.StringValidator;
 
+/**
+ * Operations allowed by querydsl
+ */
 public interface FilterOperation {
 
+    /**
+     * Not Equals Operation
+     */
     @ValidatedBy(ComparableValidator.class)
     class NEQ implements FilterOperation {
     }
 
+    /**
+     * Equals Operation
+     */
     @ValidatedBy(ComparableValidator.class)
     class EQ implements FilterOperation {
     }
 
+    /**
+     * Greater than Operation
+     */
     @ValidatedBy(ComparableValidator.class)
     class GT implements FilterOperation {
     }
 
+    /**
+     * Greater than or equals Operation
+     */
     @ValidatedBy(ComparableValidator.class)
     class GTE implements FilterOperation {
     }
 
+    /**
+     * Less than Operation
+     */
     @ValidatedBy(ComparableValidator.class)
     class LT implements FilterOperation {
     }
 
+    /**
+     * Less than or equals Operation
+     */
     @ValidatedBy(ComparableValidator.class)
     class LTE implements FilterOperation {
     }
 
+    /**
+     * Like Operation
+     */
     @ValidatedBy(StringValidator.class)
     class LIKE implements FilterOperation {
     }
 
+    /**
+     * Not Like Operation
+     */
     @ValidatedBy(CollectionValidator.class)
     class IN implements FilterOperation {
     }
 
+    /**
+     * Not In Operation
+     */
     @ValidatedBy(CollectionValidator.class)
     class NOTIN implements FilterOperation {
     }

diff --git a/src/main/java/fr/ouestfrance/querydsl/service/validators/ValidatedBy.java b/src/main/java/fr/ouestfrance/querydsl/service/validators/ValidatedBy.java
@@ -1,7 +1,5 @@
 package fr.ouestfrance.querydsl.service.validators;
 
-import fr.ouestfrance.querydsl.FilterOperation;
-
 import java.lang.annotation.*;
 
 /**