add comment() to @DiscriminatorColumn

we missed this one in 3.2
gavinking · Dec 11, 2024 · f1b2f8d · f1b2f8d
1 parent 1aac75c
commit f1b2f8d
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/api/src/main/java/jakarta/persistence/DiscriminatorColumn.java b/api/src/main/java/jakarta/persistence/DiscriminatorColumn.java
@@ -91,4 +91,12 @@
      * Ignored for other discriminator types.
      */
     int length() default 31;
+
+    /**
+     * (Optional) A comment to be applied to the column.
+     * This is only used if table generation is in effect.
+     *
+     * @since 4.0
+     */
+    String comment() default "";
 }
diff --git a/spec/src/main/asciidoc/ch11-metadata-for-or-mapping.adoc b/spec/src/main/asciidoc/ch11-metadata-for-or-mapping.adoc
@@ -1366,6 +1366,7 @@ public @interface DiscriminatorColumn {
     String columnDefinition() default "";
     String options() default "";
     int length() default 31;
+    String comment() default "";
 }
 ----
 
@@ -1403,6 +1404,12 @@ the specified discriminator type.
 |(Optional) The column length for
 String-based discriminator types. Ignored for other discriminator types.
 |31
+
+|String
+|comment
+|(Optional) Comment for the column. This is
+only used if table generation is in effect.
+|No comment
 |===
 
 *Example:*