Put the enumeration back, but keep the upper case, and shorten IGNORE_CASE to ANY_CASE

njr-11 · njr-11 · commit 179adeed7d49 · 2025-02-05T09:22:13.000-06:00
diff --git a/api/src/main/java/jakarta/data/Limit.java b/api/src/main/java/jakarta/data/Limit.java
@@ -34,7 +34,7 @@
  *
  * <pre>
  * &#64;Find
- * Product[] named(&#64;By(_Product.NAME) &#64;Is(LIKE_IGNORE_CASE) String namePattern,
+ * Product[] named(&#64;By(_Product.NAME) &#64;Is(LIKE_ANY_CASE) String namePattern,
  *                 Limit limit,
  *                 Sort&lt;Product&gt;... sorts);
  * 
diff --git a/api/src/main/java/jakarta/data/repository/Is.java b/api/src/main/java/jakarta/data/repository/Is.java
@@ -25,8 +25,10 @@
 /**
  * <p>Annotates a parameter of a repository {@link Find} or {@link Delete} method,
  * indicating how a persistent field is compared against the parameter's value.
- * The {@link By} annotation is used on the same parameter to identify the
- * persistent field.</p>
+ * The {@link By} annotation can be used on the same parameter to identify the
+ * persistent field. Otherwise, if the {@code -parameters} compile option is
+ * enabled, the the persistent field is inferred by matching the name of the
+ * method parameter.</p>
  *
  * <p>For example,</p>
  *
@@ -40,7 +42,7 @@
  *
  *     // Find a page of Product entities where the name field matches a pattern, ignoring case.
  *     &#64;Find
- *     Page&lt;Product&gt; search(&#64;By(_Product.NAME) &#64;Is(LIKE_IGNORE_CASE) String pattern,
+ *     Page&lt;Product&gt; search(&#64;By(_Product.NAME) &#64;Is(LIKE_ANY_CASE) String pattern,
  *                          PageRequest pagination,
  *                          Order&lt;Product&gt; order);
  *
@@ -53,28 +55,10 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.PARAMETER)
 public @interface Is {
-    // TODO add JavaDoc with examples to these
-    String EQUAL                = "EQUAL";
-    String GREATER_THAN         = "GREATER_THAN";
-    String GREATER_THAN_EQ      = "GREATER_THAN_EQ";
-    String IGNORE_CASE          = "IGNORE_CASE";
-    String IN                   = "IN";
-    String LESS_THAN            = "LESS_THAN";
-    String LESS_THAN_EQ         = "LESS_THAN_EQ";
-    String LIKE                 = "LIKE";
-    String LIKE_IGNORE_CASE     = "LIKE_IGNORE_CASE";
-    String NOT                  = "NOT";
-    String NOT_IGNORE_CASE      = "NOT_IGNORE_CASE";
-    String NOT_IN               = "NOT_IN";
-    String NOT_LIKE             = "NOT_LIKE";
-    String NOT_LIKE_IGNORE_CASE = "NOT_LIKE_IGNORE_CASE";
 
     /**
      * <p>The type of comparison operation to use when comparing a persistent
-     * field against a value that is supplied to a repository method.
-     * For portable applications, the comparison operation must be one of the
-     * constants defined within this class. Jakarta Data providers might choose
-     * to provide their own constants as non-portable extensions.</p>
+     * field against a value that is supplied to a repository method..</p>
      *
      * <p>The following example compares the year a person was born against
      * a minimum and maximum year that are supplied as parameters to a repository
@@ -83,7 +67,7 @@
      * <pre>
      * &#64;Find
      * &#64;OrderBy(_Person.YEAR_BORN)
-     * List&lt;Person&gt; bornWithin(&#64;By(_Person.YEAR_BORN) &#64;Is(TREATER_THAN_EQ) float minYear,
+     * List&lt;Person&gt; bornWithin(&#64;By(_Person.YEAR_BORN) &#64;Is(GREATER_THAN_EQ) float minYear,
      *                         &#64;By(_Person.YEAR_BORN) &#64;Is(LESS_THAN_EQ) float maxYear);
      * </pre>
      *
@@ -94,10 +78,54 @@
      * statically import one or more constants from this class. For example:</p>
      *
      * <pre>
-     * import static jakarta.data.repository.Is.*;
+     * import static jakarta.data.repository.Is.Op.*;
      * </pre>
      *
      * @return the type of comparison operation.
      */
-    String value() default EQUAL;
+    Op value() default Op.EQUAL;
+
+    /**
+     * <p>Comparison operations for the {@link Is} annotation.</p>
+     *
+     * <p>For more concise code, it can be convenient to statically import one
+     * or more comparison operations. For example:</p>
+     *
+     * <pre>
+     * import static jakarta.data.repository.Is.Op.*;
+     * </pre>
+     */
+    public static enum Op {
+        // TODO add JavaDoc with examples to these
+        ANY_CASE,
+        EQUAL,
+        GREATER_THAN,
+        GREATER_THAN_ANY_CASE,
+        GREATER_THAN_EQ,
+        GREATER_THAN_EQ_ANY_CASE,
+        IN,
+        LESS_THAN,
+        LESS_THAN_ANY_CASE,
+        LESS_THAN_EQ,
+        LESS_THAN_EQ_ANY_CASE,
+        LIKE,
+        LIKE_ANY_CASE,
+        PREFIXED,
+        PREFIXED_ANY_CASE,
+        SUBSTRINGED,
+        SUBSTRINGED_ANY_CASE,
+        SUFFIXED,
+        SUFFIXED_ANY_CASE,
+        NOT,
+        NOT_ANY_CASE,
+        NOT_IN,
+        NOT_LIKE,
+        NOT_LIKE_ANY_CASE,
+        NOT_PREFIXED,
+        NOT_PREFIXED_ANY_CASE,
+        NOT_SUBSTRINGED,
+        NOT_SUBSTRINGED_ANY_CASE,
+        NOT_SUFFIXED,
+        NOT_SUFFIXED_ANY_CASE;
+    }
 }
diff --git a/api/src/main/java/jakarta/data/repository/OrderBy.java b/api/src/main/java/jakarta/data/repository/OrderBy.java
@@ -118,7 +118,7 @@
      * <pre>
      * &#64;Find
      * &#64;OrderBy("age")
-     * Stream&lt;Person&gt; withLastName(&#64;By("lastName") &#64;Is(IGNORE_CASE) String surname);
+     * Stream&lt;Person&gt; withLastName(&#64;By("lastName") &#64;Is(ANY_CASE) String surname);
      * </pre>
      *
      * @return entity attribute name.
diff --git a/api/src/main/java/jakarta/data/repository/Repository.java b/api/src/main/java/jakarta/data/repository/Repository.java
@@ -39,7 +39,7 @@
  *
  *     &#64;Find
  *     &#64;OrderBy("price")
- *     List&lt;Product&gt; named(&#64;By("name") &#64;Is(LIKE_IGNORE_CASE) String namePattern);
+ *     List&lt;Product&gt; named(&#64;By("name") &#64;Is(LIKE_ANY_CASE) String namePattern);
  *
  *     &#64;Query("UPDATE Product SET price = price - (price * ?1) WHERE price * ?1 &lt;= ?2")
  *     int putOnSale(float rateOfDiscount, float maxDiscount);
diff --git a/api/src/main/java/module-info.java b/api/src/main/java/module-info.java
@@ -74,7 +74,7 @@
  *     &#64;Find
  *     &#64;OrderBy("price")
  *     List&lt;Product&gt; search(
- *             &#64;By("name") &#64;Is(LIKE_IGNORE_CASE) String namePattern,
+ *             &#64;By("name") &#64;Is(LIKE_ANY_CASE) String namePattern,
  *             &#64;By("price") &#64;Is(lESS_THAN_EQ) float max);
  *
  *     &#64;Query("UPDATE Product SET price = price * (1.0 - ?1) WHERE yearProduced &lt;= ?2")
@@ -810,7 +810,7 @@
  * &#64;Find
  * &#64;OrderBy(value = _Product.AMOUNT_SOLD, descending = true)
  * &#64;OrderBy(ID)
- * Product[] named(&#64;By(_Product.NAME) &#64;Is(LIKE_IGNORE_CASE) String pattern,
+ * Product[] named(&#64;By(_Product.NAME) &#64;Is(LIKE_ANY_CASE) String pattern,
  *                 PageRequest pageRequest);
  * ...
  * page1 = products.named("%phone%", PageRequest.ofSize(20));
@@ -828,7 +828,7 @@
  *
  * <pre>
  * &#64;Find
- * Product[] search(&#64;By("name") &#64;Is(LIKE_IGNORE_CASE) String pattern,
+ * Product[] search(&#64;By("name") &#64;Is(LIKE_ANY_CASE) String pattern,
  *                  &#64;By("price") &#64;Is(GREATER_THAN_EQ) float minPrice,
  *                  &#64;By("price") &#64;Is(LESS_THAN_EQ) float maxPrice,
  *                  PageRequest pageRequest,
@@ -848,7 +848,7 @@
  *
  * <pre>
  * &#64;Find
- * Product[] named(&#64;By("name") &#64;Is(LIKE_IGNORE_CASE) String pattern,
+ * Product[] named(&#64;By("name") &#64;Is(LIKE_ANY_CASE) String pattern,
  *                 Limit max,
  *                 Order&lt;Product&gt; sortBy);
  *
@@ -866,7 +866,7 @@
  *
  * <pre>
  * &#64;Find
- * Product[] named(&#64;By("name") &#64;Is(LIKE_IGNORE_CASE) String pattern,
+ * Product[] named(&#64;By("name") &#64;Is(LIKE_ANY_CASE) String pattern,
  *                 Limit max,
  *                 {@code Sort<?>...} sortBy);
  *

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@`
`34`	`34`	`*`
`35`	`35`	`* <pre>`
`36`	`36`	`* @Find`
`37`		`- * Product[] named(@By(_Product.NAME) @Is(LIKE_IGNORE_CASE) String namePattern,`
	`37`	`+ * Product[] named(@By(_Product.NAME) @Is(LIKE_ANY_CASE) String namePattern,`
`38`	`38`	`* Limit limit,`
`39`	`39`	`* Sort<Product>... sorts);`
`40`	`40`	`*`
Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,7 @@`
`118`	`118`	`* <pre>`
`119`	`119`	`* @Find`
`120`	`120`	`* @OrderBy("age")`
`121`		`- * Stream<Person> withLastName(@By("lastName") @Is(IGNORE_CASE) String surname);`
	`121`	`+ * Stream<Person> withLastName(@By("lastName") @Is(ANY_CASE) String surname);`
`122`	`122`	`* </pre>`
`123`	`123`	`*`
`124`	`124`	`* @return entity attribute name.`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@`
`39`	`39`	`*`
`40`	`40`	`* @Find`
`41`	`41`	`* @OrderBy("price")`
`42`		`- * List<Product> named(@By("name") @Is(LIKE_IGNORE_CASE) String namePattern);`
	`42`	`+ * List<Product> named(@By("name") @Is(LIKE_ANY_CASE) String namePattern);`
`43`	`43`	`*`
`44`	`44`	`* @Query("UPDATE Product SET price = price - (price * ?1) WHERE price * ?1 <= ?2")`
`45`	`45`	`* int putOnSale(float rateOfDiscount, float maxDiscount);`