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

PACKAGE, where it applies to all mappings defined in the package, unless defined more specifically.
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.
FIELD / METHOD, where it applies to the rows of an jakarta.persistence.ElementCollection or jakarta.persistence.ManyToMany table.
ANNOTATION_TYPE on another annotation defined according to the previous targets.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	SoftDelete.UnspecifiedConversion Used as the default for SoftDelete#converter(), indicating that dialect and settings resolution should be used.

Method Summary

Modifier and Type	Method and Description
public String	columnName() (Optional) The name of the column.
public Class<? extends AttributeConverter<Boolean, ?>>	converter() (Optional) Conversion to apply to determine the appropriate value to store in the database.
public SoftDeleteType	strategy() The strategy to use for storing/reading values to/from the database.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

columnName back to summary

columnName	back to summary
public String columnName() (Optional) The name of the column. Default depends on the strategy being used. See Also `SoftDeleteType#getDefaultColumnName()`

public String columnName()

(Optional) The name of the column.

Default depends on the strategy being used.

converter back to summary

converter	back to summary
public Class<? extends AttributeConverter<Boolean, ?>> converter() (Optional) Conversion to apply to determine the appropriate value to store in the database. The "domain representation" can be: `true` Indicates that the row is considered deleted `false` Indicates that the row is considered NOT deleted By default, values are stored as booleans in the database according to the dialect and settings API Note The converter should never return `null`

public Class<? extends AttributeConverter<Boolean, ?>> converter()

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

By default, values are stored as booleans in the database according to the dialect and settings

API Note

The converter should never return null

strategy	back to summary
public SoftDeleteType strategy() The strategy to use for storing/reading values to/from the database. The strategy also affects the default column name.

strategy

public SoftDeleteType strategy()

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

The strategy also affects the default column name.

org.hibernate.annotations back to summary

Used as the default for SoftDelete#converter(), indicating that dialect and settings resolution should be used.

Inherited from jakarta.persistence.AttributeConverter:: convertToDatabaseColumn convertToEntityAttribute