Uses of Package
org.hibernate.annotations

Packages that use org.hibernate.annotations

Package	Description
org.hibernate.annotations	A set of mapping annotations which extend the O/R mapping annotations defined by JPA.
org.hibernate.boot	This package contains the interfaces that make up the bootstrap API for Hibernate.
org.hibernate.boot.models	Overall, this module is responsible for taking managed-resources and building the hibernate-models model (ClassDetails, etc.) to ultimately be bound into Hibernate's boot-time model.
org.hibernate.boot.models.annotations.spi
org.hibernate.boot.models.spi
org.hibernate.boot.models.xml.spi
org.hibernate.boot.spi	A range of SPIs allowing integration with—and customization of—the process of building metadata.
org.hibernate.engine	This package contains classes which are "shared" by other subsystems, and implementations of some key algorithms.
org.hibernate.engine.spi	This package defines some central internal SPI abstractions used throughout the implementation of Hibernate.
org.hibernate.id	This package and its subpackages, especially org.hibernate.id.enhanced, contain the built-in id generators, all of which implement either IdentifierGenerator or PostInsertIdentifierGenerator.
org.hibernate.id.uuid	Contains the UuidGenerator.
org.hibernate.mapping	This package defines the Hibernate configuration-time mapping model.
org.hibernate.metamodel.mapping	Defines the runtime mapping metamodel, which describes the mapping of the application's domain model parts (entities, attributes) to relational database objects (tables, columns).

Classes in org.hibernate.annotations used by org.hibernate.annotations

Class	Description
AnyDiscriminatorImplicitValues.Strategy
AttributeBinderType	Associates a user-defined annotation with an AttributeBinder, allowing the annotation to drive some custom model binding.
CacheConcurrencyStrategy	Identifies policies for managing concurrent access to the shared second-level cache.
CacheLayout	Describes the data layout used for storing an object into the query cache.
CascadeType	Deprecated, for removal: This API element is subject to removal in a future version. Use the JPA-defined CascadeType.
DialectOverride.OverridesAnnotation	Marks an annotation type as a dialect-specific override for some other annotation type.
FetchMode	Enumerates methods for fetching an association from the database.
FlushModeType	Deprecated, for removal: This API element is subject to removal in a future version. Use QueryFlushMode.
IdGeneratorType	Meta-annotation used to mark another annotation as providing configuration for a custom identifier generator.
NotFoundAction	Specifies how Hibernate should handle the case of an orphaned foreign key with no associated row in the referenced table.
OnDeleteAction	Enumerates the possible actions for the on delete clause of a foreign key constraint.
OptimisticLockType	Enumerates the possible optimistic lock checking strategies.
ResultCheckStyle	Deprecated, for removal: This API element is subject to removal in a future version. Use an Expectation class instead.
SoftDeleteType	Enumeration of defines styles of soft-delete
SourceType	Specifies the source of a generated value, either the virtual machine, or the database.
TimeZoneStorageType	Describes the storage of timezone information for zoned datetime types, in particular, for the types OffsetDateTime and ZonedDateTime.
TypeBinderType	Associates a user-defined annotation with a TypeBinder, allowing the annotation to drive some custom model binding.
UuidGenerator.Style	Represents a kind of UUID, that is, what RFC 4122 calls a "version".
ValueGenerationType	Meta-annotation used to mark another annotation as providing configuration for a custom value generation strategy.

Classes in org.hibernate.annotations used by org.hibernate.boot

Class	Description
CacheLayout	Describes the data layout used for storing an object into the query cache.

Classes in org.hibernate.annotations used by org.hibernate.boot.models

Class	Description
Any	Maps a to-one cardinality association taking values over several entity types which are not related by the usual entity inheritance, using a discriminator value stored on the referring side of the relationship.
AnyDiscriminator	A simplified way to specify the type of the discriminator in an Any mapping, using the JPA-defined DiscriminatorType.
AnyDiscriminatorImplicitValues	Defines how to handle discriminator values which are not explicitly mapped with AnyDiscriminatorValue.
AnyDiscriminatorValue	Specifies the mapping of a single any-valued discriminator value to its corresponding entity type.
AnyDiscriminatorValues	List of AnyDiscriminatorValues.
AnyKeyJavaClass	Specifies the Java class to use for the foreign key handling related to an Any mapping.
AnyKeyJavaType	Form of JavaType used to describe the foreign-key part of an ANY mapping.
AnyKeyJdbcType	Form of JdbcType used to describe the foreign key part of an Any mapping.
AnyKeyJdbcTypeCode	Form of JdbcTypeCode used to describe the foreign key part of an Any mapping.
Array	Specifies the maximum length of a SQL array type mapped by the annotated attribute.
AttributeAccessor	Specifies an attribute access strategy to use.
AttributeBinderType	Associates a user-defined annotation with an AttributeBinder, allowing the annotation to drive some custom model binding.
Bag	Specifies that an attribute of type List is semantically a bag, that is, that the order of the list elements is not significant, and should not be persistent.
BatchSize	Specifies a maximum batch size for batch fetching of the annotated entity or collection.
Cache	Marks a root entity or collection for second-level caching, and specifies: a named cache region in which to store the state of instances of the entity or collection, and an appropriate cache concurrency policy, given the expected data access patterns affecting the entity or collection.
Cascade	Deprecated, for removal: This API element is subject to removal in a future version. Use the JPA-defined CascadeType
Check	Deprecated. Prefer Table.check(), Column.check(), etc., with @CheckConstraint.
Checks	Deprecated. since Check is deprecated.
Collate	Specifies a collation to use when generating DDL for the column mapped by the annotated field or property.
CollectionId	Describe the identifier for an id-bag.
CollectionIdJavaClass	Specifies the Java class to use for the id of an id-bag mapping.
CollectionIdJavaType	Form of JavaType for describing the id of an id-bag mapping.
CollectionIdJdbcType	Form of JdbcType for describing the id of an id-bag mapping.
CollectionIdJdbcTypeCode	Form of JdbcTypeCode for describing the id of an id-bag mapping.
CollectionIdMutability	Form of Mutability for describing the id of an id-bag mapping
CollectionIdType	Form of Type for describing the id of an id-bag mapping.
CollectionType	Names a custom collection type for a persistent collection.
CollectionTypeRegistration	Allows to register a UserCollectionType to use as the default for the specified classification of collection.
CollectionTypeRegistrations	Repeatable container for CollectionTypeRegistration
ColumnDefault	Specifies that a column has a default value specified in DDL.
Columns	Support an array of columns.
ColumnTransformer	Specifies custom SQL expressions used to read and write to the column mapped by the annotated persistent attribute in all generated SQL involving the annotated persistent attribute.
ColumnTransformers	Plural annotation for @ColumnTransformer.
Comment	Deprecated. Prefer Table.comment(), Column.comment(), etc.
Comments	Deprecated. Per Comment, prefer Table.comment()
CompositeType	Specifies a custom CompositeUserType for the annotated attribute mapping.
CompositeTypeRegistration	Registers a custom composite user type implementation to be used by default for all references to a particular embeddable class.
CompositeTypeRegistrations	Grouping of CompositeTypeRegistration
ConcreteProxy	Annotating ConcreteProxy on the root entity class of an inheritance hierarchy will allow types of that hierarchy to always produce proxies that resolve to the concrete subtype class.
ConverterRegistration	Registers an AttributeConverter.
ConverterRegistrations
CreationTimestamp	Specifies that the annotated field of property is a generated creation timestamp.
CurrentTimestamp	Specifies that the annotated field of property is a generated timestamp, and also specifies the timing of the timestamp generation, and whether it is generated in Java or by the database: source = VM indicates that the virtual machine current instant is used, and source = DB indicates that the database current_timestamp function should be used.
DialectOverride.Check	Specializes a Check in a certain dialect.
DialectOverride.Checks
DialectOverride.ColumnDefault	Specializes a ColumnDefault in a certain dialect.
DialectOverride.ColumnDefaults
DialectOverride.DiscriminatorFormula	Specializes a DiscriminatorFormula in a certain dialect.
DialectOverride.DiscriminatorFormulas
DialectOverride.FilterDefOverrides
DialectOverride.FilterDefs	Specializes FilterDefs in a certain dialect.
DialectOverride.FilterOverrides
DialectOverride.Filters	Specializes Filters in a certain dialect.
DialectOverride.Formula	Specializes a Formula in a certain dialect.
DialectOverride.Formulas
DialectOverride.GeneratedColumn	Specializes a GeneratedColumn in a certain dialect.
DialectOverride.GeneratedColumns
DialectOverride.JoinFormula	Specializes a JoinFormula in a certain dialect.
DialectOverride.JoinFormulas
DialectOverride.SQLDelete	Specializes a SQLDelete in a certain dialect.
DialectOverride.SQLDeleteAll	Specializes a SQLDeleteAll in a certain dialect.
DialectOverride.SQLDeleteAlls
DialectOverride.SQLDeletes
DialectOverride.SQLInsert	Specializes a SQLInsert in a certain dialect.
DialectOverride.SQLInserts
DialectOverride.SQLOrder	Specializes an SQLOrder in a certain dialect.
DialectOverride.SQLOrders
DialectOverride.SQLRestriction	Specializes a SQLRestriction in a certain dialect.
DialectOverride.SQLRestrictions
DialectOverride.SQLSelect	Specializes a SQLSelect in a certain dialect.
DialectOverride.SQLSelects
DialectOverride.SQLUpdate	Specializes a SQLUpdate in a certain dialect.
DialectOverride.SQLUpdates
DialectOverride.Version	Identifies a database version.
DiscriminatorFormula	Specifies an expression written in native SQL as the discriminator for an entity inheritance hierarchy.
DiscriminatorOptions	Optional annotation used in conjunction with the JPA-defined DiscriminatorColumn annotation to express Hibernate-specific discriminator properties.
DynamicInsert	Specifies that SQL insert statements for the annotated entity are generated dynamically, and only include the columns to which a non-null value must be assigned.
DynamicUpdate	Specifies that SQL update statements for the annotated entity are generated dynamically, and only include columns which are actually being updated.
EmbeddableInstantiator	Specifies a custom instantiator for a specific embedded
EmbeddableInstantiatorRegistration	Registers a custom instantiator implementation to be used for all references to a particular Embeddable.
EmbeddableInstantiatorRegistrations	Grouping of EmbeddableInstantiatorRegistration
EmbeddedColumnNaming	Allows specifying a pattern to be applied to the naming of columns for a particular embedded mapping.
Fetch	Specifies the default fetching method for the annotated association.
FetchProfile	Defines a fetch profile, by specifying its FetchProfile.name(), together with a list of fetch strategy overrides.
FetchProfileOverride	Overrides the fetching strategy for the annotated association in a certain named fetch profile.
FetchProfileOverrides	A group of FetchProfileOverrides.
FetchProfiles	Collects together multiple fetch profiles.
Filter	Specifies that an entity or collection is affected by a named filter declared using @FilterDef, and allows the default filter condition to be overridden for the annotated entity or collection role.
FilterDef	Declares a filter, specifying its FilterDef.name(), optionally, a default condition, and its parameter names and types, if it has parameters.
FilterDefs	Array of filter definitions.
FilterJoinTable	Specifies that the join table of a collection is affected by a named filter declared using FilterDef, and allows the default filter condition to be overridden for the annotated entity or collection role.
FilterJoinTables	Add multiple @FilterJoinTable to a collection.
Filters	Add multiple @Filters.
Formula	Specifies an expression written in native SQL that is used to read the value of an attribute instead of storing the value in a Column.
FractionalSeconds	Deprecated, for removal: This API element is subject to removal in a future version. Use Column.secondPrecision() which was introduced in JPA 3.2
Generated	Specifies that the value of the annotated property is generated by the database.
GeneratedColumn	Specifies that a column is defined using a DDL generated always as clause or equivalent, and that Hibernate should fetch the generated value from the database after each SQL INSERT or UPDATE.
GenericGenerator	Deprecated, for removal: This API element is subject to removal in a future version. Use the new approach based on IdGeneratorType.
GenericGenerators	Deprecated, for removal: This API element is subject to removal in a future version. since GenericGenerator is deprecated.
HQLSelect	Specifies a custom HQL/JPQL query to be used in place of the default SQL generated by Hibernate when an entity or collection is fetched from the database by id.
IdGeneratorType	Meta-annotation used to mark another annotation as providing configuration for a custom identifier generator.
Immutable	Marks an entity, collection, or attribute of an entity as immutable.
Imported	Marks an arbitrary class as available for use in HQL queries by its unqualified name.
Instantiator	Marks the canonical constructor to be used for instantiation of an embeddable.
JavaType	Specify an explicit BasicJavaType to use for a particular column mapping.
JavaTypeRegistration	Registers a BasicJavaType as the default Java type descriptor for the given JavaTypeRegistration.javaType().
JavaTypeRegistrations	Grouping of JavaTypeRegistration See notes on JavaTypeRegistration about using on packages versus use on classes
JdbcType	Specifies an explicit JdbcType to use for a particular column mapping. When applied to a Map-valued attribute, describes the Map value.
JdbcTypeCode	Specifies the JDBC type-code to use for the column mapping. When applied to a Map-valued attribute, describes the Map value.
JdbcTypeRegistration	Registers a JdbcType as the default JDBC type descriptor for a certain type code.
JdbcTypeRegistrations	Grouping of JdbcTypeRegistration See notes on JdbcTypeRegistration about using on packages versus use on classes
JoinColumnOrFormula	Specifies one element of a composite join condition involving both formulas and columns.
JoinColumnsOrFormulas	Specifies a composite join condition involving one or more formulas and, optionally, one or more columns.
JoinFormula	Specifies a join condition based on an arbitrary native SQL formula instead of a column name.
LazyGroup	Specifies the fetch group for a persistent attribute of an entity class.
ListIndexBase	Specifies the base value for the order column of a persistent list or array, that is, the order column value of the first element of the list or array.
ListIndexJavaType	Form of JavaType for describing the column mapping for the index of a List or array.
ListIndexJdbcType	Form of JdbcType for describing the column mapping for the index of a List or array.
ListIndexJdbcTypeCode	Form of JdbcTypeCode for describing the column mapping for the index of a List or array.
ManyToAny	Maps a to-many cardinality association taking values over several entity types which are not related by the usual entity inheritance, using a discriminator value stored in an association table.
MapKeyCompositeType	Form of CompositeType for use with map-keys
MapKeyJavaType	Form of JavaType for describing the key of a Map
MapKeyJdbcType	Form of JdbcType for describing the key of a Map
MapKeyJdbcTypeCode	Form of JdbcTypeCode for describing the key of a Map
MapKeyMutability	Form of Mutability for describing the key of a Map
MapKeyType	Form of Type for use with map keys.
Mutability	Specifies a MutabilityPlan for a basic value mapping.
NamedEntityGraph	Defines a named entity graph based on Hibernate's entity graph language.
NamedEntityGraphs	A grouping of NamedEntityGraph definitions.
NamedNativeQueries	A grouping of NamedNativeQuery definitions.
NamedNativeQuery	Declares a named query written in native SQL.
NamedQueries	A grouping of NamedQuery definitions.
NamedQuery	Declares a named query written in HQL or JPQL.
Nationalized	Specifies that the annotated character data should be stored with nationalization support.
NativeGenerator	Generator that picks a strategy based on the dialect.
NaturalId	Specifies that a field or property of an entity class is part of the natural id of the entity.
NaturalIdCache	Specifies that mappings from the natural id values of the annotated entity to the corresponding entity id values should be cached in the shared second-level cache.
NotFound	Indicates that a many to one, one to one, or many to many association maps to a column holding foreign keys, but without a foreign key constraint, and which may therefore violate referential integrity.
OnDelete	Specifies an on delete action for a foreign key constraint.
OptimisticLock	Specifies whether mutating the annotated attribute should trigger an increment to the version of the entity instance.
OptimisticLocking	Specifies how optimistic lock checking works for the annotated entity.
ParamDef	Details about a parameter declared in a FilterDef.
Parameter	Generic parameter (a key/value pair) used to parametrize other annotations.
Parent	Reference the property as a pointer back to the owner (generally the owning entity).
PartitionKey	Identifies a field of an entity that holds the partition key of a table.
PropertyRef	Allows to specify the target of a foreign-key using a "target attribute" as opposed to join column(s).
QueryCacheLayout	Configures the layout for the entity or collection data in a query cache.
RowId	Specifies that a rowid-like column or pseudo-column should be used as the row locator in CRUD operations for an entity, instead of the primary key of the table.
SecondaryRow	Specifies how the row of a SecondaryTable should be managed.
SecondaryRows	A grouping of SecondaryRows.
SoftDelete	Describes a soft-delete indicator mapping.
SortComparator	Sort a Set or Map using the given Comparator.
SortNatural	Sort a Set or Map in its natural order
Source	Deprecated, for removal: This API element is subject to removal in a future version. use CurrentTimestamp instead
SQLDelete	Specifies a custom SQL DML statement to be used in place of the default SQL generated by Hibernate when an entity or collection row is deleted from the database.
SQLDeleteAll	Specifies a custom SQL DML statement to be used in place of the default SQL generated by Hibernate when an entire collection is deleted from the database.
SQLDeletes	A grouping of SQLDeletes.
SqlFragmentAlias	Defines an interpolated alias occurring in a SQL filter condition.
SQLInsert	Specifies a custom SQL DML statement to be used in place of the default SQL generated by Hibernate when an entity or collection row is inserted in the database.
SQLInserts	A grouping of SQLInserts.
SQLJoinTableRestriction	Specifies a restriction written in native SQL to add to the generated SQL when querying the join table of a collection.
SQLOrder	Order a collection using an expression or list of expression written in native SQL.
SQLRestriction	Specifies a restriction written in native SQL to add to the generated SQL for entities or collections.
SQLSelect	Specifies a custom SQL query to be used in place of the default SQL generated by Hibernate when an entity or collection is loaded from the database by id.
SQLUpdate	Specifies a custom SQL DML statement to be used in place of the default SQL generated by Hibernate when an entity or collection row is updated in the database.
SQLUpdates	A grouping of SQLUpdates.
Struct	Specifies the UDT (user defined type) name for the annotated embeddable type or embedded attribute.
Subselect	Maps an immutable and read-only entity to a given SQL select expression.
Synchronize	Specifies a table or tables that hold state mapped by the annotated entity or collection.
TargetEmbeddable	Specifies the target type for a Embedded entity property.
TenantId	Identifies a field of an entity that holds a tenant id in discriminator-based multitenancy.
TimeZoneColumn	Specifies the mapped column for storing the time zone information, for use in conjunction with TimeZoneStorageType.COLUMN or TimeZoneStorageType.AUTO.
TimeZoneStorage	Specifies how the time zone information of a persistent property or field should be persisted.
Type	Specifies a custom UserType for the annotated attribute mapping.
TypeBinderType	Associates a user-defined annotation with a TypeBinder, allowing the annotation to drive some custom model binding.
TypeRegistration	Registers a custom user type implementation to be used by default for all references to a particular class of basic type.
TypeRegistrations	Grouping of TypeRegistration
UpdateTimestamp	Specifies that the annotated field of property is a generated update timestamp. The timestamp is regenerated every time an entity instance is updated in the database.
UuidGenerator	Specifies that an entity identifier is generated as an IETF RFC 4122 UUID.
ValueGenerationType	Meta-annotation used to mark another annotation as providing configuration for a custom value generation strategy.
View	Maps an entity to a database view.

Classes in org.hibernate.annotations used by org.hibernate.boot.models.annotations.spi

Class	Description
DialectOverride.Version	Identifies a database version.
ResultCheckStyle	Deprecated, for removal: This API element is subject to removal in a future version. Use an Expectation class instead.

Classes in org.hibernate.annotations used by org.hibernate.boot.models.spi

Class	Description
GenericGenerator	Deprecated, for removal: This API element is subject to removal in a future version. Use the new approach based on IdGeneratorType.

Classes in org.hibernate.annotations used by org.hibernate.boot.models.xml.spi

Class	Description
CascadeType	Deprecated, for removal: This API element is subject to removal in a future version. Use the JPA-defined CascadeType.

Classes in org.hibernate.annotations used by org.hibernate.boot.spi

Class	Description
CacheLayout	Describes the data layout used for storing an object into the query cache.
CascadeType	Deprecated, for removal: This API element is subject to removal in a future version. Use the JPA-defined CascadeType.
CollectionTypeRegistration	Allows to register a UserCollectionType to use as the default for the specified classification of collection.

Classes in org.hibernate.annotations used by org.hibernate.engine

Class	Description
OptimisticLockType	Enumerates the possible optimistic lock checking strategies.

Classes in org.hibernate.annotations used by org.hibernate.engine.spi

Class	Description
ResultCheckStyle	Deprecated, for removal: This API element is subject to removal in a future version. Use an Expectation class instead.

Classes in org.hibernate.annotations used by org.hibernate.id

Class	Description
NativeGenerator	Generator that picks a strategy based on the dialect.

Classes in org.hibernate.annotations used by org.hibernate.id.uuid

Class	Description
UuidGenerator	Specifies that an entity identifier is generated as an IETF RFC 4122 UUID.

Classes in org.hibernate.annotations used by org.hibernate.mapping

Class	Description
CacheLayout	Describes the data layout used for storing an object into the query cache.
FetchMode	Enumerates methods for fetching an association from the database.
NotFoundAction	Specifies how Hibernate should handle the case of an orphaned foreign key with no associated row in the referenced table.
OnDeleteAction	Enumerates the possible actions for the on delete clause of a foreign key constraint.
SoftDeleteType	Enumeration of defines styles of soft-delete
TimeZoneStorageType	Describes the storage of timezone information for zoned datetime types, in particular, for the types OffsetDateTime and ZonedDateTime.

Classes in org.hibernate.annotations used by org.hibernate.metamodel.mapping

Class	Description
SoftDeleteType	Enumeration of defines styles of soft-delete