Switch to String constants with capitalized names

njr-11 · njr-11 · commit 142cfd0c776d · 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(LikeIgnoreCase) String namePattern,
+ * Product[] named(&#64;By(_Product.NAME) &#64;Is(LIKE_IGNORE_CASE) String namePattern,
  *                 Limit limit,
  *                 Sort&lt;Product&gt;... sorts);
  * 
diff --git a/api/src/main/java/jakarta/data/page/CursoredPage.java b/api/src/main/java/jakarta/data/page/CursoredPage.java
@@ -60,7 +60,7 @@
  * &#64;OrderBy(_Employee.FIRSTNAME)
  * &#64;OrderBy(_Employee.ID)
  * CursoredPage&lt;Employee&gt; withOvertime(
- *         &#64;By(_Employee.HOURSWORKED) &#64;Is(GreaterThan) int fullTimeHours,
+ *         &#64;By(_Employee.HOURSWORKED) &#64;Is(GREATER_THAN) int fullTimeHours,
  *         PageRequest pageRequest);
  * </pre>
  *
diff --git a/api/src/main/java/jakarta/data/page/PageRequest.java b/api/src/main/java/jakarta/data/page/PageRequest.java
@@ -40,8 +40,8 @@
  * &#64;Find
  * &#64;OrderBy("age")
  * &#64;OrderBy("ssn")
- * Person[] agedBetween(&#64;By("age") &#64;Is(GreaterThanEqual) int minAge,
- *                      &#64;By("age") &#64;Is(LessThanEqual) int maxAge,
+ * Person[] agedBetween(&#64;By("age") &#64;Is(GREATER_THAN_EQ) int minAge,
+ *                      &#64;By("age") &#64;Is(LESS_THAN_EQ) int maxAge,
  *                      PageRequest pageRequest);
  * </pre>
  *
diff --git a/api/src/main/java/jakarta/data/repository/Is.java b/api/src/main/java/jakarta/data/repository/Is.java
@@ -36,26 +36,45 @@
  *
  *     // Find all Product entities where the price field is less than a maximum value.
  *     &#64;Find
- *     List&lt;Product&gt; pricedBelow(&#64;By(_Product.PRICE) &#64;Is(LessThan) float max);
+ *     List&lt;Product&gt; pricedBelow(&#64;By(_Product.PRICE) &#64;Is(LESS_THAN) float max);
  *
  *     // 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(LikeIgnoreCase) String pattern,
+ *     Page&lt;Product&gt; search(&#64;By(_Product.NAME) &#64;Is(LIKE_IGNORE_CASE) String pattern,
  *                          PageRequest pagination,
  *                          Order&lt;Product&gt; order);
  *
  *     // Remove Product entities with any of the unique identifiers listed.
  *     &#64;Delete
- *     void remove(&#64;By(ID) &#64;Is(In) List&lt;Long&gt; productIds);
+ *     void remove(&#64;By(ID) &#64;Is(IN) List&lt;Long&gt; productIds);
  * }
  * </pre>
  */
 @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.</p>
+     * 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>
      *
      * <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
@@ -64,55 +83,21 @@
      * <pre>
      * &#64;Find
      * &#64;OrderBy(_Person.YEAR_BORN)
-     * List&lt;Person&gt; bornWithin(&#64;By(_Person.YEAR_BORN) &#64;Is(GreaterThanEqual) float minYear,
-     *                         &#64;By(_Person.YEAR_BORN) &#64;Is(LessThanEqual) float maxYear);
+     * List&lt;Person&gt; bornWithin(&#64;By(_Person.YEAR_BORN) &#64;Is(TREATER_THAN_EQ) float minYear,
+     *                         &#64;By(_Person.YEAR_BORN) &#64;Is(LESS_THAN_EQ) float maxYear);
      * </pre>
      *
-     * <p>The default comparison operation is the {@linkplain Op#Equal equality}
-     * comparison.</p> 
-     *
-     * @return the type of comparison operation.
-     */
-    Op value() default Op.Equal;
-
-    /**
-     * <p>Comparison operations for the {@link Is} annotation.</p>
+     * <p>The default comparison operation is the {@linkplain #EQUAL equality}
+     * comparison.</p>
      *
-     * <p>For more concise code, it can be convenient to statically import one
-     * or more comparison operations. For example:</p>
+     * <p>For concise code, it can be convenient for a repository interface to
+     * statically import one or more constants from this class. For example:</p>
      *
      * <pre>
-     * import static jakarta.data.repository.Is.Op.*;
+     * import static jakarta.data.repository.Is.*;
      * </pre>
+     *
+     * @return the type of comparison operation.
      */
-    public static enum Op {
-        // TODO add JavaDoc with examples to these
-        Equal,
-        GreaterThan,
-        GreaterThanEqual,
-        IgnoreCase,
-        In,
-        LessThan,
-        LessThanEqual,
-        Like,
-        LikeIgnoreCase,
-        // TODO might want to give more thought to the exact names,
-        Prefixed,
-        PrefixedIgnoreCase,
-        Substringed,
-        SubstringedIgnoreCase,
-        Suffixed,
-        SuffixedIgnoreCase,
-        Not,
-        NotIgnoreCase,
-        NotIn,
-        NotLike,
-        NotLikeIgnoreCase,
-        NotPrefixed,
-        NotPrefixedIgnoreCase,
-        NotSubstringed,
-        NotSubstringedIgnoreCase,
-        NotSuffixed,
-        NotSuffixedIgnoreCase;
-    }
+    String value() default EQUAL;
 }
diff --git a/api/src/main/java/jakarta/data/repository/OrderBy.java b/api/src/main/java/jakarta/data/repository/OrderBy.java
@@ -64,7 +64,7 @@
  * <pre>
  * &#64;Find
  * &#64;OrderBy(value = _Product.PRICE, descending = true)
- * {@code Stream<Product>} pricedBelow(&#64;By(_Product.PRICE) &#64;Is(LessThan) double maxPrice);
+ * {@code Stream<Product>} pricedBelow(&#64;By(_Product.PRICE) &#64;Is(LESS_THAN) double maxPrice);
  * </pre>
  *
  * <p>A repository method with an {@code @OrderBy} annotation must not
@@ -118,7 +118,7 @@
      * <pre>
      * &#64;Find
      * &#64;OrderBy("age")
-     * Stream&lt;Person&gt; withLastName(&#64;By("lastName") &#64;Is(IgnoreCase) String surname);
+     * Stream&lt;Person&gt; withLastName(&#64;By("lastName") &#64;Is(IGNORE_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(LikeIgnoreCase) String namePattern);
+ *     List&lt;Product&gt; named(&#64;By("name") &#64;Is(LIKE_IGNORE_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,8 +74,8 @@
  *     &#64;Find
  *     &#64;OrderBy("price")
  *     List&lt;Product&gt; search(
- *             &#64;By("name") &#64;Is(LikeIgnoreCase) String namePattern,
- *             &#64;By("price") &#64;Is(LessThanEqual) float max);
+ *             &#64;By("name") &#64;Is(LIKE_IGNORE_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")
  *     int discountOldInventory(float rateOfDiscount, int maxYear);
@@ -157,7 +157,7 @@
  *     &#64;Find
  *     &#64;OrderBy("address.zipCode")
  *     List&lt;Purchase&gt; forZipCodes(
- *             &#64;By("address.zipCode") &#64;Is(In) List&lt;Integer&gt; zipCodes);
+ *             &#64;By("address.zipCode") &#64;Is(IN) List&lt;Integer&gt; zipCodes);
  *
  *     &#64;Query("WHERE address.zipCode = ?1")
  *     List&lt;Purchase&gt; forZipCode(int zipCode);
@@ -729,7 +729,7 @@
  * &#64;OrderBy("firstName")
  * List&lt;Person&gt; ofNationalityAndOlderThan(
  *         Country nationality,
- *         &#64;By("age") &#64;Is(GreaterThan) int minAge);
+ *         &#64;By("age") &#64;Is(GREATER_THAN) int minAge);
  * </pre>
  *
  * <pre>
@@ -739,7 +739,7 @@
  *
  * <pre>
  * &#64;Delete
- * void remove(&#64;By("status") &#64;Is(In) List&lt;Status&gt; list);
+ * void remove(&#64;By("status") &#64;Is(IN) List&lt;Status&gt; list);
  * </pre>
  *
  * <p>The {@code _} character may be used in a method parameter name to
@@ -767,8 +767,8 @@
  * &#64;Find
  * Vehicle[] search(String make,
  *                  String model,
- *                  &#64;By(_Vehicle.YEAR) &#64;Is(GreaterThanEqual) int minYear,
- *                  &#64;By(_Vehicle.YEAR) &#64;Is(LessThanEqual) int maxYear,
+ *                  &#64;By(_Vehicle.YEAR) &#64;Is(GREATER_THAN_EQ) int minYear,
+ *                  &#64;By(_Vehicle.YEAR) &#64;Is(LESS_THAN_EQ) int maxYear,
  *                  Sort&lt;?&gt;... sorts);
  * </pre>
  *
@@ -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(LikeIgnoreCase) String pattern,
+ * Product[] named(&#64;By(_Product.NAME) &#64;Is(LIKE_IGNORE_CASE) String pattern,
  *                 PageRequest pageRequest);
  * ...
  * page1 = products.named("%phone%", PageRequest.ofSize(20));
@@ -828,9 +828,9 @@
  *
  * <pre>
  * &#64;Find
- * Product[] search(&#64;By("name") &#64;Is(LikeIgnoreCase) String pattern,
- *                  &#64;By("price") &#64;Is(GreaterThanEqual) float minPrice,
- *                  &#64;By("price") &#64;Is(LessThanEqual) float maxPrice,
+ * Product[] search(&#64;By("name") &#64;Is(LIKE_IGNORE_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,
  *                  Order&lt;Product&gt; order);
  *
@@ -848,7 +848,7 @@
  *
  * <pre>
  * &#64;Find
- * Product[] named(&#64;By("name") &#64;Is(LikeIgnoreCase) String pattern,
+ * Product[] named(&#64;By("name") &#64;Is(LIKE_IGNORE_CASE) String pattern,
  *                 Limit max,
  *                 Order&lt;Product&gt; sortBy);
  *
@@ -866,7 +866,7 @@
  *
  * <pre>
  * &#64;Find
- * Product[] named(&#64;By("name") &#64;Is(LikeIgnoreCase) String pattern,
+ * Product[] named(&#64;By("name") &#64;Is(LIKE_IGNORE_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(LikeIgnoreCase) String namePattern,`
	`37`	`+ * Product[] named(@By(_Product.NAME) @Is(LIKE_IGNORE_CASE) String namePattern,`
`38`	`38`	`* Limit limit,`
`39`	`39`	`* Sort<Product>... sorts);`
`40`	`40`	`*`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@`
`60`	`60`	`* @OrderBy(_Employee.FIRSTNAME)`
`61`	`61`	`* @OrderBy(_Employee.ID)`
`62`	`62`	`* CursoredPage<Employee> withOvertime(`
`63`		`- * @By(_Employee.HOURSWORKED) @Is(GreaterThan) int fullTimeHours,`
	`63`	`+ * @By(_Employee.HOURSWORKED) @Is(GREATER_THAN) int fullTimeHours,`
`64`	`64`	`* PageRequest pageRequest);`
`65`	`65`	`* </pre>`
`66`	`66`	`*`
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(LikeIgnoreCase) String namePattern);`
	`42`	`+ * List<Product> named(@By("name") @Is(LIKE_IGNORE_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);`