org.hibernate.annotations.Check Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of beangle-hibernate-core Show documentation

Hibernate Orm Core Shade,Support Scala Collection

There is a newer version: 6.6.2.Final

Show newest version

/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or .
 */
package org.hibernate.annotations;

import java.lang.annotation.Repeatable;
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.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Specifies a {@code check} constraint to be included in the generated DDL.
 * 
 * When a basic-typed field or property is annotated, the check constraint is
 *     added to the {@linkplain jakarta.persistence.Column column} definition.
 * 
When a {@link jakarta.persistence.ManyToOne} association is annotated, the
 *     check constraint is added to the {@linkplain jakarta.persistence.JoinColumn
 *     join column} definition.
 * 
When an owned collection is annotated, the check constraint is added to the
 *     {@linkplain jakarta.persistence.CollectionTable collection table} or
 *     {@linkplain jakarta.persistence.JoinTable association join table}.
 * 
When an entity class is annotated, the check constraint is added to either
 *     the {@linkplain jakarta.persistence.Table primary table} or to a
 *     {@linkplain jakarta.persistence.SecondaryTable secondary table}, depending
 *     on which columns are involved in the constraint expression specified by
 *     {@link #constraints()}.
 * 
 * 
 * For an entity with {@linkplain jakarta.persistence.SecondaryTable secondary tables},
 * a check constraint may involve columns of the primary table, or columns of any one
 * of the secondary tables. But it may not involve columns of more than one table.
 * 
 * An entity may have multiple {@code @Check} annotations, each defining a different
 * constraint.
 *
 * @author Emmanuel Bernard
 * @author Gavin King
 *
 * @see DialectOverride.Check
 */
@Target({TYPE, METHOD, FIELD})
@Retention(RUNTIME)
@Repeatable(Checks.class)
public @interface Check {
	/**
	 * The optional name of the check constraint.
	 */
	String name() default "";
	/**
	 * The check constraint, written in native SQL.
	 */
	String constraints();
}