com.github.drinkjava2.jdialects.annotation.jdia.PKey Maven / Gradle / Ivy

Go to download
/*
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later. See
 * the lgpl.txt file in the root directory or
 * .
 */
package com.github.drinkjava2.jdialects.annotation.jdia;

import java.lang.annotation.Target;

import com.github.drinkjava2.jdialects.annotation.jpa.Column;
import com.github.drinkjava2.jdialects.annotation.jpa.GeneratedValue;

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 PKey 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:
 *
 *   @Pkey
 *   public Long getId() { return id; }
 * 
 *
 * @see Column
 * @see GeneratedValue
 * 
 */
@Target({METHOD, FIELD})
@Retention(RUNTIME)

public @interface PKey {}