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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsqlbox Show documentation

jSqlBox is a full function DAO tool

There is a newer version: 5.0.15.jre8

/*
 * Copyright 2016 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by
 * applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
 * OF ANY KIND, either express or implied. See the License for the specific
 * language governing permissions and limitations under the License.
 */
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 {}