org.hibernate.annotations.CollectionId 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.Retention;
import java.lang.annotation.Target;

import org.hibernate.id.IdentifierGenerator;

import jakarta.persistence.Column;

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

/**
 * Describe an identifier column for a bag.
 *
 * @author Emmanuel Bernard
 */
@Target({METHOD, FIELD})
@Retention(RUNTIME)
public @interface CollectionId {
	/**
	 * The column containing the collection id.
	 */
	Column column() default @Column;

	/**
	 * Implementation for generating values.
	 *
	 * @apiNote Mutually exclusive with {@link #generator()}
	 */
	Class generatorImplementation() default IdentifierGenerator.class;

	/**
	 * The generator name.
	 * 
	 * Can specify either a built-in strategy ({@code "sequence"}, for example)
	 * or a named JPA id generator.
	 *
	 * @apiNote Mutually exclusive with {@link #generatorImplementation()}
	 */
	String generator() default "";
}