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.binder.internal Built-in implementations ofAttributeBinder
andTypeBinder
.org.hibernate.boot This package contains the interfaces that make up the bootstrap API for Hibernate.org.hibernate.boot.internal org.hibernate.boot.jaxb.mapping org.hibernate.boot.jaxb.mapping.marshall org.hibernate.boot.model.internal org.hibernate.boot.model.process.internal 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.profile Models the fetch profiles defined by the application.org.hibernate.engine.spi This package defines some central internal SPI abstractions used throughout the implementation of Hibernate.org.hibernate.generator.internal org.hibernate.id.uuid Contains theUuidGenerator
.org.hibernate.mapping This package defines the Hibernate configuration-time mapping model.org.hibernate.metamodel.mapping.internal org.hibernate.sql.results.graph.entity.internal org.hibernate.testing.orm.domain.animal Standard model for Hibernate's legacy Animal model used in HQL testingorg.hibernate.testing.orm.domain.gambit org.hibernate.testing.orm.domain.retail org.hibernate.testing.orm.domain.userguide org.hibernate.tuple Most contracts here have been replaced by the new runtime mapping model. -
Classes in org.hibernate.annotations used by org.hibernate.annotations Class Description AnyDiscriminatorValue Specifies the mapping of a single any-valued discriminator value to its corresponding entity type.AttributeBinderType Associates a user-defined annotation with anAttributeBinder
, 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.CacheModeType Deprecated.CascadeType Enumerates the persistence operations which may be cascaded from one entity instance to associated entity instances.Check Specifies acheck
constraint to be included in the generated DDL.CollectionTypeRegistration Allows to register aUserCollectionType
to use as the default for the specified classification of collection.ColumnDefault Specifies that a column has adefault
value specified in DDL.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.Comment Specifies a comment that will be included in generated DDL.CompositeTypeRegistration Registers a custom composite user type implementation to be used by default for all references to a particular embeddable class.ConverterRegistration Registers anAttributeConverter
.DialectOverride.Check Specializes aCheck
in a certain dialect.DialectOverride.ColumnDefault Specializes aColumnDefault
in a certain dialect.DialectOverride.DiscriminatorFormula Specializes aDiscriminatorFormula
in a certain dialect.DialectOverride.FilterDefs SpecializesFilterDefs
in a certain dialect.DialectOverride.Filters SpecializesFilters
in a certain dialect.DialectOverride.Formula Specializes aFormula
in a certain dialect.DialectOverride.GeneratedColumn Specializes aGeneratedColumn
in a certain dialect.DialectOverride.JoinFormula Specializes aJoinFormula
in a certain dialect.DialectOverride.OrderBy Deprecated, for removal: This API element is subject to removal in a future version.DialectOverride.OverridesAnnotation Marks an annotation type as a dialect-specific override for some other annotation type.DialectOverride.SQLDelete Specializes aSQLDelete
in a certain dialect.DialectOverride.SQLDeleteAll Specializes aSQLDeleteAll
in a certain dialect.DialectOverride.SQLInsert Specializes aSQLInsert
in a certain dialect.DialectOverride.SQLOrder Specializes anSQLOrder
in a certain dialect.DialectOverride.SQLRestriction Specializes aSQLRestriction
in a certain dialect.DialectOverride.SQLSelect Specializes aSQLSelect
in a certain dialect.DialectOverride.SQLUpdate Specializes aSQLUpdate
in a certain dialect.DialectOverride.Version Identifies a database version.DialectOverride.Where Deprecated.DiscriminatorFormula Specifies an expression written in native SQL as the discriminator for an entity inheritance hierarchy.EmbeddableInstantiatorRegistration Registers a custom instantiator implementation to be used for all references to a particularEmbeddable
.FetchMode Enumerates methods for fetching an association from the database.FetchProfile Defines a fetch profile, by specifying itsFetchProfile.name()
, together with a list of fetch strategy overrides.FetchProfile.FetchOverride Overrides the fetching strategy for a particular association in the named fetch profile being defined.FetchProfileOverride Overrides the fetching strategy for the annotated association in a certain named fetch profile.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 usingFilterDef
, and allows the default filter condition to be overridden for the annotated entity or collection role.Filters Add multiple@Filters
.FlushModeType Enumeration extending the JPA flush modes with flush modes specific to Hibernate, and a "null" mode,FlushModeType.PERSISTENCE_CONTEXT
, for use as a default annotation value.ForeignKey Deprecated, for removal: This API element is subject to removal in a future version.use the JPA 2.1ForeignKey
annotationFormula Specifies an expression written in native SQL that is used to read the value of an attribute instead of storing the value in aColumn
.GeneratedColumn Specifies that a column is defined using a DDLgenerated always as
clause or equivalent, and that Hibernate should fetch the generated value from the database after each SQLINSERT
orUPDATE
.GenerationTime Deprecated.useEventType
andEventTypeSets
insteadGenericGenerator Deprecated.Use the new approach based onIdGeneratorType
.IdGeneratorType Meta-annotation used to mark another annotation as providing configuration for a custom identifier generator.Index Deprecated.UseIndex
instead.JavaTypeRegistration Registers aBasicJavaType
as the default Java type descriptor for the givenJavaTypeRegistration.javaType()
.JdbcTypeRegistration JoinColumnOrFormula JoinFormula Specifies a join condition based on an arbitrary native SQL formula instead of a column name.LazyCollectionOption Deprecated.Use the JPA-definedFetchType.EAGER
instead ofLazyCollection(FALSE)
.LazyToOneOption NamedNativeQuery Declares a named query written in native SQL.NamedQuery Declares a named query written in HQL or JPQL.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 theon delete
clause of a foreign key constraint.OptimisticLockType Enumerates the possible optimistic lock checking strategies.OrderBy Deprecated, for removal: This API element is subject to removal in a future version.UseSQLOrder
instead.ParamDef Details about a parameter declared in aFilterDef
.Parameter Generic parameter (basically a key/value combination) used to parametrize other annotations.PolymorphismType Deprecated.sincePolymorphism
is deprecatedResultCheckStyle Deprecated.Use anExpectation
class instead.SecondaryRow Specifies how the row of aSecondaryTable
should be managed.SoftDeleteType Enumeration of defines styles of soft-deleteSourceType Specifies the source of a generated value, either the virtual machine, or the database.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.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.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.Table Deprecated, for removal: This API element is subject to removal in a future version.The options available here are all now offered by other newer and better-designed annotations in this package.TimeZoneStorageType Describes the storage of timezone information for zoned datetime types, in particular, for the typesOffsetDateTime
andZonedDateTime
.TypeBinderType Associates a user-defined annotation with aTypeBinder
, 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.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.Where Deprecated.UseSQLRestriction
-
Classes in org.hibernate.annotations used by org.hibernate.binder.internal Class Description AttributeAccessor Specifies an attribute access strategy to use.BatchSize Specifies a maximum batch size for batch fetching of the annotated entity or collection.Collate Specifies a collation to use when generating DDL for the column mapped by the annotated field or property.Comment Specifies a comment that will be included in generated DDL.Comments A list ofComment
s.DiscriminatorOptions Optional annotation used in conjunction with the JPA-definedDiscriminatorColumn
annotation to express Hibernate-specific discriminator properties.TenantId Identifies a field of an entity that holds a tenant id in discriminator-based multitenancy. -
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.internal Class Description CacheLayout Describes the data layout used for storing an object into the query cache.CollectionTypeRegistration Allows to register aUserCollectionType
to use as the default for the specified classification of collection. -
Classes in org.hibernate.annotations used by org.hibernate.boot.jaxb.mapping Class Description OnDeleteAction Enumerates the possible actions for theon delete
clause of a foreign key constraint.PolymorphismType Deprecated.sincePolymorphism
is deprecatedUuidGenerator.Style Represents a kind of UUID, that is, what RFC 4122 calls a "version". -
Classes in org.hibernate.annotations used by org.hibernate.boot.jaxb.mapping.marshall Class Description OnDeleteAction Enumerates the possible actions for theon delete
clause of a foreign key constraint.PolymorphismType Deprecated.sincePolymorphism
is deprecatedUuidGenerator.Style Represents a kind of UUID, that is, what RFC 4122 calls a "version". -
Classes in org.hibernate.annotations used by org.hibernate.boot.model.internal Class Description 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.CacheConcurrencyStrategy Identifies policies for managing concurrent access to the shared second-level cache.Cascade Specifies the persistence operations that should cascade to associated entity instances.CollectionType Names a custom collection type for a persistent collection.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.DiscriminatorFormula Specifies an expression written in native SQL as the discriminator for an entity inheritance hierarchy.FetchProfile.FetchOverride Overrides the fetching strategy for a particular association in the named fetch profile being defined.FetchProfileOverride Overrides the fetching strategy for the annotated association in a certain named fetch profile.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.Formula Specifies an expression written in native SQL that is used to read the value of an attribute instead of storing the value in aColumn
.FractionalSeconds Indicates that the associated temporal value should be stored with fractional seconds.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.Index Deprecated.UseIndex
instead.IndexColumn Deprecated.JoinColumnOrFormula JoinFormula Specifies a join condition based on an arbitrary native SQL formula instead of a column name.ListIndexBase Specifies the base value for theorder column
of a persistent list or array, that is, the order column value of the first element of the list or array.NamedNativeQueries A grouping ofNamedNativeQuery
definitions.NamedNativeQuery Declares a named query written in native SQL.NamedQueries A grouping ofNamedQuery
definitions.NamedQuery Declares a named query written in HQL or JPQL.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 theon delete
clause of a foreign key constraint.OrderBy Deprecated, for removal: This API element is subject to removal in a future version.UseSQLOrder
instead.QueryCacheLayout Configures the layout for the entity or collection data in a query cache.SoftDelete Describes a soft-delete indicator mapping.SortComparator SortNatural SqlFragmentAlias Defines an interpolated alias occurring in a SQL filter condition.SQLOrder Order a collection using an expression or list of expression written in native SQL.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.Table Deprecated, for removal: This API element is subject to removal in a future version.The options available here are all now offered by other newer and better-designed annotations in this package.Tables Deprecated, for removal: This API element is subject to removal in a future version.sinceTable
is deprecated -
Classes in org.hibernate.annotations used by org.hibernate.boot.model.process.internal Class Description TimeZoneStorageType Describes the storage of timezone information for zoned datetime types, in particular, for the typesOffsetDateTime
andZonedDateTime
. -
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.CollectionTypeRegistration Allows to register aUserCollectionType
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.profile Class Description FetchMode Enumerates methods for fetching an association from the database. -
Classes in org.hibernate.annotations used by org.hibernate.engine.spi Class Description ResultCheckStyle Deprecated.Use anExpectation
class instead. -
Classes in org.hibernate.annotations used by org.hibernate.generator.internal Class Description 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, andsource = DB
indicates that the databasecurrent_timestamp
function should be used.Generated Specifies that the value of the annotated property is generated by the database.GenerationTime Deprecated.useEventType
andEventTypeSets
insteadSource Deprecated.useCurrentTimestamp
insteadSourceType Specifies the source of a generated value, either the virtual machine, or the database.TenantId Identifies a field of an entity that holds a tenant id in discriminator-based multitenancy.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. -
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 theon delete
clause of a foreign key constraint.SoftDeleteType Enumeration of defines styles of soft-deleteTimeZoneStorageType Describes the storage of timezone information for zoned datetime types, in particular, for the typesOffsetDateTime
andZonedDateTime
. -
Classes in org.hibernate.annotations used by org.hibernate.metamodel.mapping.internal Class Description NotFoundAction Specifies how Hibernate should handle the case of an orphaned foreign key with no associated row in the referenced table. -
Classes in org.hibernate.annotations used by org.hibernate.sql.results.graph.entity.internal Class Description NotFoundAction Specifies how Hibernate should handle the case of an orphaned foreign key with no associated row in the referenced table. -
Classes in org.hibernate.annotations used by org.hibernate.testing.orm.domain.animal Class Description 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.SortNatural -
Classes in org.hibernate.annotations used by org.hibernate.testing.orm.domain.gambit Class Description CollectionId Describe an identifier column for a bag.CollectionIdJdbcTypeCode Form ofJdbcTypeCode
for describing the id of an id-bag mapping.GenericGenerator Deprecated.Use the new approach based onIdGeneratorType
.JdbcTypeCode Specifies the JDBC type-code to use for the column mapping. When applied to a Map-valued attribute, describes the Map value.NaturalId Specifies that a field or property of an entity class is part of the natural id of the entity.SortComparator SortNatural SQLOrder Order a collection using an expression or list of expression written in native SQL. -
Classes in org.hibernate.annotations used by org.hibernate.testing.orm.domain.retail Class Description NaturalId Specifies that a field or property of an entity class is part of the natural id of the entity. -
Classes in org.hibernate.annotations used by org.hibernate.testing.orm.domain.userguide Class Description NamedNativeQuery Declares a named query written in native SQL.NamedQuery Declares a named query written in HQL or JPQL. -
Classes in org.hibernate.annotations used by org.hibernate.tuple Class Description CreationTimestamp Specifies that the annotated field of property is a generated creation timestamp.GenerationTime Deprecated.useEventType
andEventTypeSets
insteadGeneratorType Deprecated.ValueGenerationType
andAnnotationValueGeneration
now provide a much more powerful and typesafe alternativeUpdateTimestamp 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.