javax.persistence.Id Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hibernate-jpa-2.1-api Show documentation

Clean-room definition of JPA APIs intended for use in developing Hibernate JPA implementation. See README.md for details

The newest version!

/*
 * Copyright (c) 2008, 2009, 2011 Oracle, Inc. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
 * which accompanies this distribution.  The Eclipse Public License is available
 * at http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution License
 * is available at http://www.eclipse.org/org/documents/edl-v10.php.
 */
package javax.persistence;

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

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

/**
 * 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 {
}