-
@Target({METHOD,FIELD}) @Retention(RUNTIME) public @interface GeneratedValue
Specifies a generation strategy for generated primary keys.The
GeneratedValue
annotation may be applied to a primary key property or field of an entity or mapped superclass in conjunction with theId
annotation. The persistence provider is only required to support theGeneratedValue
for simple primary keys. Use of theGeneratedValue
annotation for derived primary keys is not supported.Example 1: {@snippet :
- Since:
- 1.0
- See Also:
GenerationType
,Id
,TableGenerator
,SequenceGenerator
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description java.lang.String
generator
(Optional) The name of the primary key generator to use, as specified by theSequenceGenerator
orTableGenerator
annotation which declares the generator.GenerationType
strategy
(Optional) The primary key generation strategy that the persistence provider must use to generate the annotated entity primary key.
-
-
-
Element Detail
-
strategy
GenerationType strategy
(Optional) The primary key generation strategy that the persistence provider must use to generate the annotated entity primary key.- Default:
- jakarta.persistence.GenerationType.AUTO
-
-
-
generator
java.lang.String generator
(Optional) The name of the primary key generator to use, as specified by theSequenceGenerator
orTableGenerator
annotation which declares the generator.The name defaults to the entity name of the entity in which the annotation occurs.
If there is no generator with the defaulted name, then the persistence provider supplies a default id generator, of a type compatible with the value of the
strategy()
member.- Default:
- ""
-
-