Top Description Methods

org.eclipse.persistence.annotations

public @Interface PrimaryKey

Annotations

extends Annotation

@Target:TYPE
@Retention:RUNTIME

Imports

java.lang.annotation.Retention, .Target, jakarta.persistence.Column

The PrimaryKey annotation allows advanced configuration of the Id. A validation policy can be given that allows specifying if zero is a valid id value. The set of primary key columns can also be specified precisely.

Author: James Sutherland
Since: EclipseLink 1.1

Method Summary

Modifier and Type	Method and Description
public CacheKeyType	cacheKeyType() (Optional) Configures what cache key type is used to store the object in the cache.
public Column[]	columns() (Optional) Used to specify the primary key columns directly.
public IdValidation	validation() (Optional) Configures what id validation is done.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

cacheKeyType	back to summary
public CacheKeyType cacheKeyType() (Optional) Configures what cache key type is used to store the object in the cache. By default the type is determined by what type is optimal for the class.

columns	back to summary
public Column[] columns() (Optional) Used to specify the primary key columns directly. This can be used instead of @Id if the primary key includes a non basic field, such as a foreign key, or a inheritance discriminator, embedded, or transformation mapped field.

validation	back to summary
public IdValidation validation() (Optional) Configures what id validation is done. By default 0 is not a valid id value, this can be used to allow 0 id values.