By default, if on is not specified:
But when on is explicitly specified, the comment applies to the mapped table
or column with the specified name.
For example:
@Entity
@Table(name = "book")
@SecondaryTable(name = "edition")
@Comment("The primary table for Book")
@Comment(on = "edition",
value = "The secondary table for Book")
class Book { ... }
API Note
In principle, it's possible for a column of a secondary table to have the
same name as a column of the primary table, or as a column of some other
secondary table. Therefore, on may be ambiguous.
| Modifier and Type | Method and Description |
|---|---|
| public String | |
| public String |
| on | back to summary |
|---|---|
| public String on() The name of the table or column to add the comment to. | |
| value | back to summary |
|---|---|
| public String value() The text of the comment. | |