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

import org.hibernate.Incubating;
import org.hibernate.dialect.Dialect;

import jakarta.persistence.AttributeConverter;

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

/**
 * Describes a soft-delete indicator mapping.
 * 
 * Soft deletes handle "deletions" from a database table by setting a column in
 * the table to indicate deletion.
 * 

 * May be defined at various levels

 *     
 *         {@linkplain ElementType#PACKAGE PACKAGE}, where it applies to all
 *         mappings defined in the package, unless defined more specifically.
 *     
 *     
 *         {@linkplain ElementType#TYPE TYPE}, where it applies to an entity hierarchy.
 *         The annotation must be defined on the root of the hierarchy and affects to the
 *         hierarchy as a whole. The soft-delete column is assumed to be on the hierarchy's
 *         root table.
 *     
 *     
 *         {@linkplain ElementType#FIELD FIELD} / {@linkplain ElementType#METHOD METHOD}, where
 *         it applies to the rows of an {@link jakarta.persistence.ElementCollection} or
 *         {@link jakarta.persistence.ManyToMany} table.
 *     
 *     
 *         {@linkplain ElementType#ANNOTATION_TYPE ANNOTATION_TYPE} on another annotation
 *         defined according to the previous targets.
 *     
 * 
 *
 * @since 6.4
 * @author Steve Ebersole
 */
@Target({PACKAGE, TYPE, FIELD, METHOD, ANNOTATION_TYPE})
@Retention(RUNTIME)
@Documented
@Incubating
public @interface SoftDelete {
	/**
	 * (Optional) The name of the column.
	 * 
	 * Default depends on the {@linkplain #strategy() strategy} being used.
	 *
	 * @see SoftDeleteType#getDefaultColumnName()
	 */
	String columnName() default "";

	/**
	 * The strategy to use for storing/reading values to/from the database.
	 * 

	 * The strategy also affects the default {@linkplain #columnName() column name}.
	 */
	SoftDeleteType strategy() default SoftDeleteType.DELETED;

	/**
	 * (Optional) Conversion to apply to determine the appropriate value to
	 * store in the database.  The "domain representation" can be: 

	 *     {@code true}
	 *     Indicates that the row is considered deleted
	 *
	 *     {@code false}
	 *     Indicates that the row is considered NOT deleted
	 * 
	 * 
	 * By default, values are stored as booleans in the database according to
	 * the {@linkplain Dialect#getPreferredSqlTypeCodeForBoolean() dialect}
	 * and {@linkplain org.hibernate.cfg.MappingSettings#PREFERRED_BOOLEAN_JDBC_TYPE settings}
	 *
	 * @apiNote The converter should never return {@code null}
	 */
	Class> converter() default UnspecifiedConversion.class;

	/**
	 * Used as the default for {@linkplain SoftDelete#converter()}, indicating that
	 * {@linkplain Dialect#getPreferredSqlTypeCodeForBoolean() dialect} and
	 * {@linkplain org.hibernate.cfg.MappingSettings#PREFERRED_BOOLEAN_JDBC_TYPE settings}
	 * resolution should be used.
	 */
	interface UnspecifiedConversion extends AttributeConverter {}
}