jakarta.persistence.Id Maven / Gradle / Ivy

/*
 * Copyright (c) 2008, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0,
 * or the Eclipse Distribution License v. 1.0 which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
 */

// Contributors:
//     Linda DeMichiel - 2.1
//     Linda DeMichiel - 2.0

package jakarta.persistence;

import java.lang.annotation.Target;
import java.lang.annotation.Retention;
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 1.0
 */
@Target({METHOD, FIELD})
@Retention(RUNTIME)

public @interface Id {}