org.hibernate.annotations.Bag 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 http://www.gnu.org/licenses/lgpl-2.1.html
 */
package org.hibernate.annotations;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

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

/**
 * Specifies that an attribute of type {@link java.util.List} is semantically
 * a {@linkplain org.hibernate.metamodel.CollectionClassification#BAG bag},
 * that is, that the order of the list elements is not significant, and should
 * not be persistent.
 * 
 * This annotation is not necessary, and has no effect, unless the configuration
 * property {@value org.hibernate.cfg.AvailableSettings#DEFAULT_LIST_SEMANTICS}
 * is set to {@link org.hibernate.metamodel.CollectionClassification#LIST}.
 * However, its use is still encouraged, since the explicit annotation serves
 * as useful documentation.
 *
 * @apiNote This annotation causes an exception if the attribute is also annotated
 *          {@link jakarta.persistence.OrderColumn} or {@link ListIndexBase}.
 *
 * @author Steve Ebersole
 */
@Target({METHOD, FIELD, ANNOTATION_TYPE})
@Retention(RUNTIME)
public @interface Bag {
}