deprecate @mapkey(name=..) and replace with @mapkey(..)

see jakartaee#684 Signed-off-by: Gavin King <[email protected]>
gavinking · Nov 11, 2024 · 56a6c98 · 56a6c98
1 parent 1aac75c
commit 56a6c98
Showing 1 changed file with 15 additions and 1 deletion.
diff --git a/api/src/main/java/jakarta/persistence/MapKey.java b/api/src/main/java/jakarta/persistence/MapKey.java
@@ -63,7 +63,7 @@
  * public class Department {
  *     ...
  *     @OneToMany(mappedBy = "department")
- *     @MapKey(name = "name")
+ *     @MapKey("name")
  *     public Map<String, Employee> getEmployees() {... }
  *     ...
  * }
@@ -95,5 +95,19 @@
      * mapped as {@link IdClass}, an instance of the primary key
      * class is used as the key.
      */
+    String value() default "";
+
+    /**
+     * (Optional) The name of the persistent field or property of
+     * the associated entity that is used as the map key.
+     * <p> Default: If the {@code name} element is not specified,
+     * the primary key of the associated entity is used as the map
+     * key. If the primary key is a composite primary key and is
+     * mapped as {@link IdClass}, an instance of the primary key
+     * class is used as the key.
+     *
+     * @deprecated Use {@link #value} instead
+     */
+    @Deprecated(since = "4.0")
     String name() default "";
 }