All Classes
-
All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary Class Description AbstractQuery<T> TheAbstractQuery
interface defines functionality that is common to both top-level queries and subqueries.Access Used to specify an access type to be applied to an entity class, mapped superclass, or embeddable class, or to a specific attribute of such a class.AccessType Used with theAccess
annotation to specify an access type to be applied to an entity class, mapped superclass, or embeddable class, or to a specific attribute of such a class.AssociationOverride Used to override a mapping for an entity relationship.AssociationOverrides Used to override mappings of multiple relationship properties or fields.Attribute<X,Y> Represents an attribute of a Java type.Attribute.PersistentAttributeType AttributeConverter<X,Y> A class that implements this interface can be used to convert entity attribute state into database column representation and back again.AttributeNode<T> Represents an attribute node of an entity graph.AttributeOverride Used to override the mapping of aBasic
(whether explicit or default) property or field orId
property or field.AttributeOverrides Used to override mappings of multiple properties or fields.Basic The simplest type of mapping to a database column.BasicType<X> Instances of the typeBasicType
represent basic types (including temporal and enumerated types).Bindable<T> Instances of the typeBindable
represent object or attribute types that can be bound into aPath
.Bindable.BindableType Cache Interface used to interact with the second-level cache.Cacheable Specifies whether an entity should be cached if caching is enabled when the value of thepersistence.xml
caching element isENABLE_SELECTIVE
orDISABLE_SELECTIVE
.CacheRetrieveMode Used as the value of thejakarta.persistence.cache.retrieveMode
property to specify the behavior when data is retrieved by thefind
methods and by queries.CacheStoreMode Used as the value of thejakarta.persistence.cache.storeMode
property to specify the behavior when data is read from the database and when data is committed into the database.CascadeType Defines the set of cascadable operations that are propagated to the associated entity.ClassTransformer A persistence provider supplies an instance of this interface to thePersistenceUnitInfo.addTransformer
method.CollectionAttribute<X,E> Instances of the typeCollectionAttribute
represent persistentjava.util.Collection
-valued attributes.CollectionJoin<Z,E> TheCollectionJoin
interface is the type of the result of joining to a collection over an association or element collection that has been specified as ajava.util.Collection
.CollectionTable Specifies the table that is used for the mapping of collections of basic or embeddable types.Column Specifies the mapped column for a persistent property or field.ColumnResult Used in conjunction with theSqlResultSetMapping
annotation orConstructorResult
annotation to map a column of the SELECT list of a SQL query.CommonAbstractCriteria TheCommonAbstractCriteria
interface defines functionality that is common to both top-level criteria queries and subqueries as well as to update and delete criteria operations.CompoundSelection<X> TheCompoundSelection
interface defines a compound selection item (tuple, array, or result of constructor).ConstraintMode Used to control the application of a constraint.ConstructorResult Used in conjunction with theSqlResultSetMapping
annotation to map the SELECT clause of a SQL query to a constructor.Convert Specifies the conversion of a Basic field or property.Converter Specifies that the annotated class is a converter and defines its scope.Converts Used to groupConvert
annotations.CriteriaBuilder Used to construct criteria queries, compound selections, expressions, predicates, orderings.CriteriaBuilder.Case<R> Interface used to build general case expressions.CriteriaBuilder.Coalesce<T> Interface used to build coalesce expressions.CriteriaBuilder.In<T> Interface used to build in predicates.CriteriaBuilder.SimpleCase<C,R> Interface used to build simple case expressions.CriteriaBuilder.Trimspec Used to specify how strings are trimmed.CriteriaDelete<T> TheCriteriaDelete
interface defines functionality for performing bulk delete operations using the Criteria APICriteriaQuery<T> TheCriteriaQuery
interface defines functionality that is specific to top-level queries.CriteriaUpdate<T> TheCriteriaUpdate
interface defines functionality for performing bulk update operations using the Criteria API.DiscriminatorColumn DiscriminatorType Defines supported types of the discriminator column.DiscriminatorValue Specifies the value of the discriminator column for entities of the given type.ElementCollection Specifies a collection of instances of a basic type or embeddable class.Embeddable Specifies a class whose instances are stored as an intrinsic part of an owning entity and share the identity of the entity.EmbeddableType<X> Instances of the typeEmbeddableType
represent embeddable types.Embedded Specifies a persistent field or property of an entity whose value is an instance of an embeddable class.EmbeddedId Applied to a persistent field or property of an entity class or mapped superclass to denote a composite primary key that is an embeddable class.Entity Specifies that the class is an entity.EntityExistsException Thrown by the persistence provider whenEntityManager.persist(Object)
is called and the entity already exists.EntityGraph<T> This type represents the root of an entity graph that will be used as a template to define the attribute nodes and boundaries of a graph of entities and entity relationships.EntityListeners Specifies the callback listener classes to be used for an entity or mapped superclass.EntityManager Interface used to interact with the persistence context.EntityManagerFactory Interface used to interact with the entity manager factory for the persistence unit.EntityNotFoundException Thrown by the persistence provider when an entity reference obtained byEntityManager.getReference
is accessed but the entity does not exist.EntityResult Used in conjunction with theSqlResultSetMapping
annotation to map the SELECT clause of a SQL query to an entity result.EntityTransaction Interface used to control transactions on resource-local entity managers.EntityType<X> Instances of the typeEntityType
represent entity types.Enumerated Specifies that a persistent property or field should be persisted as a enumerated type.EnumType Defines mapping for enumerated types.ExcludeDefaultListeners Specifies that the invocation of default listeners is to be excluded for the entity class (or mapped superclass) and its subclasses.ExcludeSuperclassListeners Specifies that the invocation of superclass listeners is to be excluded for the entity class (or mapped superclass) and its subclasses.Expression<T> Type for query expressions.Fetch<Z,X> Represents a join-fetched association or attribute.FetchParent<Z,X> Represents an element of the from clause which may function as the parent of Fetches.FetchType Defines strategies for fetching data from the database.FieldResult Used in conjunction with theEntityResult
annotation to map columns specified in the SELECT list of a SQL query to the properties or fields of an entity class.FlushModeType Flush mode setting.ForeignKey Used to specify the handling of foreign key constraints when schema generation is in effect.From<Z,X> Represents a bound type, usually an entity that appears in the from clause, but may also be an embeddable belonging to an entity in the from clause.GeneratedValue Provides for the specification of generation strategies for the values of primary keys.GenerationType Defines the types of primary key generation strategies.Id Specifies the primary key of an entity.IdClass Specifies a composite primary key class that is mapped to multiple fields or properties of the entity.IdentifiableType<X> Instances of the typeIdentifiableType
represent entity or mapped superclass types.Index Used in schema generation to specify creation of an index.Inheritance Specifies the inheritance strategy to be used for an entity class hierarchy.InheritanceType Defines inheritance strategy options.Join<Z,X> A join to an entity, embeddable, or basic type.JoinColumn Specifies a column for joining an entity association or element collection.JoinColumns Specifies the mapping for composite foreign keys.JoinTable Specifies the mapping of associations.JoinType Defines the three types of joins.ListAttribute<X,E> Instances of the typeListAttribute
represent persistentjava.util.List
-valued attributes.ListJoin<Z,E> TheListJoin
interface is the type of the result of joining to a collection over an association or element collection that has been specified as ajava.util.List
.LoadState Load states returned by theProviderUtil
SPI methods.Lob Specifies that a persistent property or field should be persisted as a large object to a database-supported large object type.LockModeType Lock modes can be specified by means of passing aLockModeType
argument to one of theEntityManager
methods that take locks (lock
,find
, orrefresh
) or to theQuery.setLockMode()
orTypedQuery.setLockMode()
method.LockTimeoutException Thrown by the persistence provider when an pessimistic locking conflict occurs that does not result in transaction rollback.ManagedType<X> Instances of the typeManagedType
represent entity, mapped superclass, and embeddable types.ManyToMany Specifies a many-valued association with many-to-many multiplicity.ManyToOne Specifies a single-valued association to another entity class that has many-to-one multiplicity.MapAttribute<X,K,V> Instances of the typeMapAttribute
represent persistentjava.util.Map
-valued attributes.MapJoin<Z,K,V> TheMapJoin
interface is the type of the result of joining to a collection over an association or element collection that has been specified as ajava.util.Map
.MapKey Specifies the map key for associations of typejava.util.Map
when the map key is itself the primary key or a persistent field or property of the entity that is the value of the map.MapKeyClass Specifies the type of the map key for associations of typejava.util.Map
.MapKeyColumn Specifies the mapping for the key column of a map whose map key is a basic type.MapKeyEnumerated Specifies the enum type for a map key whose basic type is an enumerated type.MapKeyJoinColumn Specifies a mapping to an entity that is a map key.MapKeyJoinColumns Supports composite map keys that reference entities.MapKeyTemporal MappedSuperclass Designates a class whose mapping information is applied to the entities that inherit from it.MappedSuperclassType<X> Instances of the typeMappedSuperclassType
represent mapped superclass types.MapsId Designates aManyToOne
orOneToOne
relationship attribute that provides the mapping for anEmbeddedId
primary key, an attribute within anEmbeddedId
primary key, or a simple primary key of the parent entity.Metamodel Provides access to the metamodel of persistent entities in the persistence unit.NamedAttributeNode ANamedAttributeNode
is a member element of aNamedEntityGraph
.NamedEntityGraph Used to specify the path and boundaries for a find operation or query.NamedEntityGraphs Used to groupNamedEntityGraph
annotations.NamedNativeQueries Specifies multiple native SQL named queries.NamedNativeQuery Specifies a named native SQL query.NamedQueries Specifies multiple named Jakarta Persistence query language queries.NamedQuery Specifies a static, named query in the Jakarta Persistence query language.NamedStoredProcedureQueries Specifies multiple named stored procedure queries.NamedStoredProcedureQuery Specifies and names a stored procedure, its parameters, and its result type.NamedSubgraph ANamedSubgraph
is a member element of aNamedEntityGraph
.NonUniqueResultException Thrown by the persistence provider whenQuery.getSingleResult()
orTypedQuery.getSingleResult()
is executed on a query and there is more than one result from the query.NoResultException Thrown by the persistence provider whenQuery.getSingleResult()
orTypedQuery.getSingleResult()
is executed on a query and there is no result to return.OneToMany Specifies a many-valued association with one-to-many multiplicity.OneToOne Specifies a single-valued association to another entity that has one-to-one multiplicity.OptimisticLockException Thrown by the persistence provider when an optimistic locking conflict occurs.Order An object that defines an ordering over the query results.OrderBy Specifies the ordering of the elements of a collection valued association or element collection at the point when the association or collection is retrieved.OrderColumn Specifies a column that is used to maintain the persistent order of a list.Parameter<T> Type for query parameter objects.ParameterExpression<T> Type of criteria query parameter expressions.ParameterMode Specifies the mode of a parameter of a stored procedure query.Path<X> Represents a simple or compound attribute path from a bound type or collection, and is a "primitive" expression.Persistence Bootstrap class that is used to obtain anEntityManagerFactory
in Java SE environments.PersistenceContext Expresses a dependency on a container-managedEntityManager
and its associated persistence context.PersistenceContexts Declares one or morePersistenceContext
annotations.PersistenceContextType Specifies whether a transaction-scoped or extended persistence context is to be used inPersistenceContext
.PersistenceException Thrown by the persistence provider when a problem occurs.PersistenceProperty Describes a single container or persistence provider property.PersistenceProvider Interface implemented by the persistence provider.PersistenceProviderResolver Determine the list of persistence providers available in the runtime environment.PersistenceProviderResolverHolder Holds the globalPersistenceProviderResolver
instance.PersistenceUnit Expresses a dependency on anEntityManagerFactory
and its associated persistence unit.PersistenceUnitInfo Interface implemented by the container and used by the persistence provider when creating anEntityManagerFactory
.PersistenceUnits Declares one or morePersistenceUnit
annotations.PersistenceUnitTransactionType Specifies whether entity managers created by theEntityManagerFactory
will be JTA or resource-local entity managers.PersistenceUnitUtil Utility interface between the application and the persistence provider managing the persistence unit.PersistenceUtil Utility interface between the application and the persistence provider(s).PessimisticLockException Thrown by the persistence provider when an pessimistic locking conflict occurs.PessimisticLockScope Defines the values of thejakarta.persistence.lock.scope
property for pessimistic locking.PluralAttribute<X,C,E> Instances of the typePluralAttribute
represent persistent collection-valued attributes.PluralAttribute.CollectionType PluralJoin<Z,C,E> ThePluralJoin
interface defines functionality that is common to joins to all collection types.PostLoad Specifies a callback method for the corresponding lifecycle event.PostPersist Specifies a callback method for the corresponding lifecycle event.PostRemove Specifies a callback method for the corresponding lifecycle event.PostUpdate Specifies a callback method for the corresponding lifecycle event.Predicate The type of a simple or compound predicate: a conjunction or disjunction of restrictions.Predicate.BooleanOperator PrePersist Specifies a callback method for the corresponding lifecycle event.PreRemove Specifies a callback method for the corresponding lifecycle event.PreUpdate Specifies a callback method for the corresponding lifecycle event.PrimaryKeyJoinColumn Specifies a primary key column that is used as a foreign key to join to another table.PrimaryKeyJoinColumns GroupsPrimaryKeyJoinColumn
annotations.ProviderUtil Utility interface implemented by the persistence provider.Query Interface used to control query execution.QueryHint Used to supply a query property or hint to theNamedQuery
orNamedNativeQuery
annotation.QueryTimeoutException Thrown by the persistence provider when a query times out and only the statement is rolled back.RollbackException Thrown by the persistence provider whenEntityTransaction.commit()
fails.Root<X> A root type in the from clause.SecondaryTable Specifies a secondary table for the annotated entity class.SecondaryTables Specifies multiple secondary tables for an entity.Selection<X> TheSelection
interface defines an item that is to be returned in a query result.SequenceGenerator Defines a primary key generator that may be referenced by name when a generator element is specified for theGeneratedValue
annotation.SequenceGenerators Used to groupSequenceGenerator
annotations.SetAttribute<X,E> Instances of the typeSetAttribute
represent persistentjava.util.Set
-valued attributes.SetJoin<Z,E> TheSetJoin
interface is the type of the result of joining to a collection over an association or element collection that has been specified as ajava.util.Set
.SharedCacheMode Specifies how the provider must use a second-level cache for the persistence unit.SingularAttribute<X,T> Instances of the typeSingularAttribute
represents persistent single-valued properties or fields.SqlResultSetMapping Specifies the mapping of the result of a native SQL query or stored procedure.SqlResultSetMappings Is used to define one or moreSqlResultSetMapping
annotations.StaticMetamodel TheStaticMetamodel
annotation specifies that the class is a metamodel class that represents the entity, mapped superclass, or embeddable class designated by the value element.StoredProcedureParameter Specifies a parameter of a named stored procedure query.StoredProcedureQuery Interface used to control stored procedure query execution.Subgraph<T> This type represents a subgraph for an attribute node that corresponds to a Managed Type.Subquery<T> TheSubquery
interface defines functionality that is specific to subqueries.SynchronizationType Specifies whether the persistence context is always automatically synchronized with the current transaction or whether the persistence context must be explicitly joined to the current transaction by means of theEntityManager.joinTransaction()
method.Table Specifies the primary table for the annotated entity.TableGenerator Defines a primary key generator that may be referenced by name when a generator element is specified for theGeneratedValue
annotation.TableGenerators Used to groupTableGenerator
annotations.Temporal This annotation must be specified for persistent fields or properties of typejava.util.Date
andjava.util.Calendar
.TemporalType Type used to indicate a specific mapping ofjava.util.Date
orjava.util.Calendar
.TransactionRequiredException Thrown by the persistence provider when a transaction is required but is not active.TransformerException Thrown by the persistence provider when a problem during class re-definition occurs.Transient Specifies that the property or field is not persistent.Tuple Interface for extracting the elements of a query result tuple.TupleElement<X> TheTupleElement
interface defines an element that is returned in a query result tuple.Type<X> Instances of the typeType
represent persistent object or attribute types.Type.PersistenceType TypedQuery<X> Interface used to control the execution of typed queries.UniqueConstraint Specifies that a unique constraint is to be included in the generated DDL for a primary or secondary table.ValidationMode The validation mode to be used by the provider for the persistence unit.Version Specifies the version field or property of an entity class that serves as its optimistic lock value.