Package org.hibernate.annotations

Package containing all the Hibernate specific annotations.

Class Summary

Class	Description
QueryHints	Consolidation of hints available to Hibernate JPA queries.

Enum Summary

Enum	Description
CacheConcurrencyStrategy	Cache concurrency strategy.
CacheModeType	Enumeration for the different interaction modes between the session and the Level 2 Cache.
CascadeType	Cascade types (can override default JPA cascades).
FetchMode	Fetch options on associations.
FlushModeType	Enumeration extending javax.persistence flush modes.
GenerationTime	At what time(s) will the generation occur?
LazyCollectionOption	Lazy options available for a collection.
LazyToOneOption	Lazy options available for a ToOne association.
NotFoundAction	Possible actions when an associated entity is not found in the database.
OnDeleteAction	Possible actions for on-delete.
OptimisticLockType	Possible optimistic locking strategies.
PolymorphismType	Type of available polymorphism for a particular entity.
ResultCheckStyle	Possible styles of checking return codes on SQL INSERT, UPDATE and DELETE queries.
SortType	Deprecated. Since Sort is deprecated.
SourceType	Where should Hibernate retrieve the value from? From the database, or from the current JVM?

Annotation Types Summary

Annotation Type	Description
AccessType	Deprecated. Use AttributeAccessor instead; renamed to avoid confusion with the JPA AccessType enum.
Any	Defines a ToOne-style association pointing to one of several entity types depending on a local discriminator, as opposed to discriminated inheritance where the discriminator is kept as part of the entity hierarchy.
AnyMetaDef	Used to provide metadata about an Any or ManyToAny mapping.
AnyMetaDefs	Used to group together AnyMetaDef annotations.
AttributeAccessor	Names a persistent property access strategy (PropertyAccessStrategy) to use.
BatchSize	Defines size for batch loading of collections or lazy entities.
Cache	Add caching strategy to a root entity or a collection.
Cascade	Apply a cascade strategy on an association.
Check	Arbitrary SQL CHECK constraints which can be defined at the class, property or collection level.
CollectionId	Describe an identifier column for a bag (ie an idbag).
CollectionType	Names a custom collection type for a persistent collection.
ColumnDefault	Identifies the DEFAULT value to apply to the associated column via DDL.
Columns	Support an array of columns.
ColumnTransformer	Custom SQL expression used to read the value from and write a value to a column.
ColumnTransformers	Plural annotation for @ColumnTransformer.
CreationTimestamp	Marks a property as the creation timestamp of the containing entity.
DiscriminatorFormula	Used to apply a Hibernate formula (derived value) as the inheritance discriminator "column".
DiscriminatorOptions	Optional annotation to express Hibernate specific discrimintor properties.
DynamicInsert	For inserting, should this entity use dynamic sql generation where only non-null columns get referenced in the prepared sql statement?
DynamicUpdate	For updating, should this entity use dynamic sql generation where only changed columns get referenced in the prepared sql statement?
Entity	Deprecated. See individual attributes for intended replacements.
Fetch	Define the fetching strategy used for the given association.
FetchProfile	Define the fetching strategy profile.
FetchProfile.FetchOverride	Descriptor for a particular association override.
FetchProfiles	Collects together multiple fetch profiles.
Filter	Add filters to an entity or a target entity of a collection.
FilterDef	Filter definition.
FilterDefs	Array of filter definitions.
FilterJoinTable	Add filters to a join table collection.
FilterJoinTables	Add multiple @FilterJoinTable to a collection.
Filters	Add multiple @Filters.
ForeignKey	Deprecated. Prefer the JPA 2.1 introduced ForeignKey instead.
Formula	Defines a formula (derived value) which is a SQL fragment that acts as a @Column alternative in most cases.
Generated	The annotated property is generated by the database.
GeneratorType	Marks a property as generated, specifying the ValueGenerator type to be used for generating the value.
GenericGenerator	Generator annotation describing any kind of Hibernate generator in a generic (de-typed) manner.
GenericGenerators	Array of generic generator definitions.
Immutable	Mark an Entity, a Collection, or an Attribute type as immutable.
Index	Deprecated. Using Index instead.
IndexColumn	Deprecated. Prefer the standard JPA OrderColumn annotation and the Hibernate specific ListIndexBase (for replacing IndexColumn.base()).
JoinColumnOrFormula	Allows joins based on column or a formula.
JoinColumnsOrFormulas	Collection of @JoinColumnOrFormula definitions.
JoinFormula	To be used as a replacement for @JoinColumn in most places.
LazyCollection	Define the lazy status of a collection.
LazyGroup	For use with bytecode-enhanced lazy-loading support.
LazyToOne	Define the laziness options available for a ToOne (ie OneToOne or ManyToOne) association.
ListIndexBase	Defines the start index value for a list index as stored on the database.
Loader	Used to override how Hibernate performs load operations.
ManyToAny	This is the collection-valued form of @Any definitions.
MapKeyType	Allows defining the type of the key of a persistent map.
MetaValue	Maps a given discriminator value to the corresponding entity type.
NamedNativeQueries	A grouping of Hibernate-specific NamedNativeQuery definitions.
NamedNativeQuery	Extends NamedNativeQuery with Hibernate features.
NamedQueries	A grouping of Hibernate-specific NamedQuery definitions.
NamedQuery	Extends NamedQuery with Hibernate features.
Nationalized	Marks a character data type (String, Character, character, Clob) as being a nationalized variant (NVARCHAR, NCHAR, NCLOB, etc).
NaturalId	This specifies that a property is part of the natural id of the entity.
NaturalIdCache	Used to specify that the natural id values associated with the annotated entity should be cached in Hibernate's shared (L2) cache.
NotFound	Action to do when an element is not found on a association.
OnDelete	Strategy to use on collections, arrays and on joined subclasses delete.
OptimisticLock	Whether or not a change of the annotated property will trigger a entity version increment.
OptimisticLocking	Used to define the style of optimistic locking to be applied to an entity.
OrderBy	Order a collection using SQL ordering (not HQL ordering).
ParamDef	A parameter definition.
Parameter	Generic parameter (basically a key/value combination) used to parametrize other annotations.
Parent	Reference the property as a pointer back to the owner (generally the owning entity).
Persister	Specify a custom persister.
Polymorphism	Used to define the type of polymorphism Hibernate will apply to entity hierarchies.
Proxy	Lazy and proxy configuration of a particular class.
RowId	Support for ROWID mapping feature of Hibernate.
SelectBeforeUpdate	Should the entity's current state be selected from the database when determining whether to perform an update when re-attaching detached entities?
Sort	Deprecated. Use SortComparator or SortNatural instead depending on need.
SortComparator	Specifies in-memory Set/Map sorting using a specified Comparator for sorting.
SortNatural	Specifies in-memory Set/Map sorting using natural sorting.
Source	Optional annotation in conjunction with Version and timestamp version properties indicating the source of the timestamp value.
SQLDelete	Custom SQL statement for delete of an entity/collection.
SQLDeleteAll	Custom SQL statement for delete of all of a collection's elements.
SqlFragmentAlias	Describe aliases for filters.
SQLInsert	Custom SQL statement for insertion of an entity/collection.
SQLUpdate	Custom SQL statement for update of an entity/collection.
Subselect	Map an immutable and read-only entity to a given SQL select expression.
Synchronize	Ensures that auto-flush happens correctly and that queries against the derived entity do not return stale data.
Table	Complementary information to a table either primary or secondary.
Tables	A grouping of tables.
Target	Define an explicit target, avoiding reflection and generics resolving.
Tuplizer	Define a tuplizer for an entity or a component.
Tuplizers	Grouping of tuplizers.
Type	Defines a Hibernate type mapping.
TypeDef	A type definition.
TypeDefs	Plural form of TypeDef.
UpdateTimestamp	Marks a property as the update timestamp of the containing entity.
ValueGenerationType	Marks an annotation type as a generator annotation type.
Where	Where clause to add to the element Entity or target entity of a collection.
WhereJoinTable	Where clause to add to the collection join table.