javax.persistence.Id Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of persistence-api Show documentation

The newest version!

package javax.persistence;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * Specifies the primary key of an entity. The field or property to which the Id annotation is applied should be one of the
 * following types: any Java primitive type; any primitive wrapper type; String; java.util.Date;
 * java.sql.Date; java.math.BigDecimal; java.math.BigInteger.
 * 
 * 
 * The mapped column for the primary key of the entity is assumed to be the primary key of the primary table. If no Column
 * annotation is specified, the primary key column name is assumed to be the name of the primary key property or field.
 * 
 * 
 *   Example:
 * 
 *   @Id
 *   public Long getId() { return id; }
 * 
 * 
 * @see Column
 * @see GeneratedValue
 * 
 * @since Java Persistence 1.0
 */
@Target({ METHOD, FIELD })
@Retention(RUNTIME)
public @interface Id {}