All Classes and Interfaces

Class
Description
The AbstractQuery interface defines functionality that is common to both top-level queries and subqueries.
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.
Used with the Access 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.
Used to override a mapping for an entity relationship.
Used to override mappings of multiple relationship properties or fields.
Represents an attribute of a Java type.
 
Interface implemented by custom attribute converters.
Represents an attribute node of an entity graph.
Used to override the mapping of a Basic (whether explicit or default) property or field or Id property or field.
Used to override mappings of multiple properties or fields.
The simplest type of mapping of a persistent field or property to a single database column.
An instance of BasicType represents a basic type (possibly an enumerated, LOB, or temporal type).
An instances of the type Bindable represents an object or attribute type that can be bound into a Path.
 
Interface used to interact with the second-level cache.
Specifies whether an entity should be cached, if caching is enabled, and when the value of the persistence.xml caching element is SharedCacheMode.ENABLE_SELECTIVE or SharedCacheMode.DISABLE_SELECTIVE.
Specifies how the EntityManager interacts with the second-level cache when data is read from the database via the EntityManager.find(java.lang.Class<T>, java.lang.Object) methods and execution of queries.
Specifies how the EntityManager interacts with the second-level cache when data is read from the database and when data is written to the database.
Defines the set of cascadable operations that are propagated to the associated entity.
Used to specify a SQL check constraint on a column or table when schema generation is in effect.
A persistence provider supplies an instance of this interface to the PersistenceUnitInfo.addTransformer(jakarta.persistence.spi.ClassTransformer) method.
Instances of the type CollectionAttribute represent persistent Collection-valued attributes.
The CollectionJoin interface is the type of the result of joining to a collection over an association or element collection that has been specified as a Collection.
Specifies the table that is used for the mapping of collections of basic or embeddable types.
Specifies the column mapped by the annotated persistent property or field.
Used in conjunction with the SqlResultSetMapping, NamedNativeQuery, or ConstructorResult annotation to map a column of the SELECT list of a SQL query.
The CommonAbstractCriteria interface defines functionality that is common to both top-level criteria queries and subqueries as well as to update and delete criteria operations.
The CompoundSelection interface defines a compound selection item (a tuple, array, or result of a constructor).
An executable action which makes use of a native database connection.
A function which makes use of a native database connection to compute a result.
Used to control the application of a constraint.
Used in conjunction with the SqlResultSetMapping or NamedNativeQuery annotation to map the SELECT clause of a SQL query to a constructor.
Specifies how the values of a field or property are converted to a basic type, enabling a converter defined autoApply=false, overriding the use of a converter defined autoApply=true, or overriding the use of a converter specified by a field or property of an embedded type or inherited mapped superclass.
Declares that the annotated class is a converter and specifies whether the converter is automatically applied.
Used to group Convert annotations.
Used to construct criteria queries, compound selections, expressions, predicates, orderings.
Interface used to build general case expressions.
Interface used to build coalesce expressions.
Interface used to build in predicates.
Interface used to build simple case expressions.
Used to specify how strings are trimmed.
The CriteriaDelete interface defines functionality for performing bulk delete operations using the Criteria API
The CriteriaQuery interface defines functionality that is specific to top-level queries.
Abstracts over top-level queries and unions and intersections of top-level queries.
The CriteriaUpdate interface defines functionality for performing bulk update operations using the Criteria API.
Specifies the discriminator column for the SINGLE_TABLE and JOINED inheritance mapping strategies.
Defines supported types of the discriminator column.
Specifies the value of the discriminator column for the annotated entity type.
Declares a collection of instances of a basic type or embeddable class.
Declares a type whose instances are stored as an intrinsic part of an owning entity, sharing the identity of the entity.
An instance of EmbeddableType represents an embeddable type.
Declares a persistent field or property of an entity whose value is an instance of an embeddable class.
Specifies that the annotated persistent field or property of an entity class or mapped superclass is the composite primary key of the entity.
Declares that the annotated class is an entity.
Thrown by the persistence provider when EntityManager.persist(Object) is called and the entity already exists.
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.
Specifies the callback listener classes to be used for an entity or mapped superclass.
Interface used to interact with the persistence context.
Interface used to interact with the persistence unit, and to create new instances of EntityManager.
Thrown by the persistence provider when an entity reference obtained by EntityManager.getReference is accessed but the entity does not exist.
Used in conjunction with the SqlResultSetMapping or NamedNativeQuery annotation to map the SELECT clause of a SQL query to an entity result.
Interface used to control transactions on resource-local entity managers.
An instance of EntityType represents an entity type.
Specifies that a persistent property or field should be persisted as an enumerated type.
Specifies that an annotated field of a Java enum type is the source of database column values for an enumerated mapping.
Enumerates available options for mapping enumerated types.
Specifies that the invocation of default listeners is to be excluded for the entity class (or mapped superclass) and its subclasses.
Specifies that the invocation of superclass listeners is to be excluded for the entity class (or mapped superclass) and its subclasses.
Type for query expressions.
Represents a join-fetched association or attribute.
Represents an element of the from clause which may function as the parent of Fetches.
Defines strategies for fetching data from the database.
Used in conjunction with the EntityResult annotation to map columns specified in the SELECT list of a SQL query to the properties or fields of an entity class.
An option influencing the behavior of EntityManager.find(java.lang.Class<T>, java.lang.Object).
Enumerates flush modes recognized by the EntityManager.
Specifies the handling of foreign key constraints when schema generation is in effect.
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.
Specifies a generation strategy for generated primary keys.
Enumerates the defined primary key generation strategies.
Declares operations common to EntityGraph and Subgraph.
Identifies the primary key of an entity.
Specifies a composite primary key type whose fields or properties map to the identifier fields or properties of the annotated entity class.
An instance of the type IdentifiableType represents an entity or mapped superclass type.
Used in schema generation to specify creation of an index.
Specifies the inheritance mapping strategy for the entity class hierarchy which descends from the annotated entity class.
Enumerated the options for mapping entity inheritance.
A join to an entity, embeddable, or basic type.
Specifies a column for joining an entity association or element collection.
Specifies the mapping for composite foreign keys.
Specifies the mapping of an association to an intermediate join table.
Defines the three varieties of join.
Instances of the type ListAttribute represent persistent List-valued attributes.
The ListJoin interface is the type of the result of joining to a collection over an association or element collection that has been specified as a List.
Load states returned by the ProviderUtil SPI methods.
Specifies that the annotated persistent property or field should be persisted as a large object to a database-native large object (LOB) type.
Each instance represents a type of field which can be extracted from a LocalDate.
Each instance represents a type of field which can be extracted from a LocalDateTime.
Each instance represents a type of field which can be extracted from a LocalTime.
Enumerates the kinds of optimistic or pessimistic lock which may be obtained on an entity instance.
Thrown by the persistence provider when a pessimistic locking conflict occurs that does not result in transaction rollback.
Instances of the type ManagedType represent entity, mapped superclass, and embeddable types.
Specifies a many-valued association with many-to-many multiplicity, mapping to an intermediate table called the join table.
Specifies a single-valued association to another entity class that has many-to-one multiplicity.
Instances of the type MapAttribute represent persistent Map-valued attributes.
The MapJoin interface is the type of the result of joining to a collection over an association or element collection that has been specified as a Map.
Specifies the map key for associations of type 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.
Specifies the type of the map key for associations of type Map.
Specifies the mapping for the key column of a map whose map key is a basic type.
Specifies the enum type for a map key whose basic type is an enumerated type.
Specifies a mapping to an entity that is a map key.
Supports composite map keys that reference entities.
Deprecated.
Newly-written code should use the date/time types defined in java.time.
Declares a class which is not itself an entity, but whose mappings are inherited by the entities which extend it.
An instance of the type MappedSuperclassType represents a mapped superclass type.
Designates a ManyToOne or OneToOne relationship attribute that provides the mapping for an EmbeddedId primary key, an attribute within an EmbeddedId primary key, or a simple primary key of the parent entity.
Provides access to the metamodel of persistent entities in the persistence unit.
A NamedAttributeNode is a member element of a NamedEntityGraph.
Defines a named entity graph.
Used to group NamedEntityGraph annotations.
Declares multiple native SQL named queries.
Declares a named native SQL query and, optionally, the mapping of the result of the native SQL query.
Declares multiple named Jakarta Persistence query language queries.
Declares a named query written in the Jakarta Persistence query language.
Specifies multiple named stored procedure queries.
Declares and names a stored procedure, its parameters, and its result type.
A NamedSubgraph is a member element of a NamedEntityGraph.
Thrown by the persistence provider when Query.getSingleResult() or TypedQuery.getSingleResult() is executed and there is more than one result from the query.
Thrown by the persistence provider when Query.getSingleResult() or TypedQuery.getSingleResult() is executed and there is no result to return.
Specifies the precedence of null values within query result sets.
Specifies a many-valued association with one-to-many multiplicity.
Specifies a single-valued association to another entity class that has one-to-one multiplicity.
Thrown by the persistence provider when an optimistic locking conflict occurs.
An object that defines an ordering over the query results.
Specifies the ordering of the elements of a collection-valued association or element collection at the point when the association or collection is retrieved.
Specifies a column that is used to maintain the persistent order of a list.
Type for query parameter objects.
Type of criteria query parameter expressions.
Specifies the mode of a parameter of a stored procedure query.
Represents a simple or compound attribute path from a bound type or collection, and is a "primitive" expression.
Bootstrap class used to obtain an EntityManagerFactory in Java SE environments.
Represents a configuration of a persistence unit, allowing programmatic creation of an EntityManagerFactory.
Expresses a dependency on a container-managed EntityManager and its associated persistence context.
Declares one or more PersistenceContext annotations.
Specifies whether a transaction-scoped or extended persistence context is to be used in PersistenceContext.
Thrown by the persistence provider when a problem occurs.
Describes a single container or persistence provider property.
Interface implemented by the persistence provider.
Provides a list of persistence providers available in the runtime environment.
Holds the global PersistenceProviderResolver instance.
Expresses a dependency on an EntityManagerFactory and its associated persistence unit.
Interface implemented by the container and used by the persistence provider when creating an EntityManagerFactory.
Declares one or more PersistenceUnit annotations.
Enumerates the possible approaches to transaction management in Jakarta Persistence.
Deprecated, for removal: This API element is subject to removal in a future version.
Utility interface between the application and the persistence provider managing the persistence unit.
Utility interface between the application and the persistence provider(s).
Thrown by the persistence provider when a pessimistic locking conflict occurs.
Defines the values of the jakarta.persistence.lock.scope property for pessimistic locking.
Instances of the type PluralAttribute represent persistent collection-valued attributes.
 
The PluralJoin interface defines functionality that is common to joins to all collection types.
Specifies a callback method for the corresponding lifecycle event.
Specifies a callback method for the corresponding lifecycle event.
Specifies a callback method for the corresponding lifecycle event.
Specifies a callback method for the corresponding lifecycle event.
The type of a simple or compound predicate: a conjunction or disjunction of restrictions.
 
Specifies a callback method for the corresponding lifecycle event.
Specifies a callback method for the corresponding lifecycle event.
Specifies a callback method for the corresponding lifecycle event.
Specifies a primary key column that is used as a foreign key to join to another table.
Groups PrimaryKeyJoinColumn annotations.
Utility interface implemented by the persistence provider.
Interface used to control query execution.
Used to supply a query property or hint to the NamedQuery or NamedNativeQuery annotation.
Thrown by the persistence provider when a query times out and only the statement is rolled back.
An option influencing the behavior of EntityManager.refresh(java.lang.Object).
Thrown by the persistence provider when EntityTransaction.commit() fails.
A root type in the from clause.
Allows programmatic schema creation, schema validation, data cleanup, and schema cleanup for entities belonging to a certain persistence unit.
Thrown when schema validation fails.
Specifies a secondary table for the annotated entity class.
Specifies multiple secondary tables for an entity.
The Selection interface defines an item that is to be returned in a query result.
Defines a primary key generator that may be referenced by name when a generator element is specified for the GeneratedValue annotation.
Used to group SequenceGenerator annotations.
Instances of the type SetAttribute represent persistent Set-valued attributes.
The SetJoin interface is the type of the result of joining to a collection over an association or element collection that has been specified as a Set.
Specifies how the provider must use a second-level cache for the persistence unit.
Instances of the type SingularAttribute represents persistent single-valued properties or fields.
Specifies a mapping of the columns of a result set of a native SQL query or stored procedure.
Used to define one or more SqlResultSetMapping annotations.
The StaticMetamodel annotation specifies that the class is a metamodel class that represents the entity, mapped superclass, or embeddable class designated by the StaticMetamodel.value() element.
Declares a parameter of a named stored procedure query.
Interface used to control stored procedure query execution.
This type represents a subgraph for an attribute node that corresponds to a managed type.
The Subquery interface defines functionality that is specific to subqueries.
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 the EntityManager.joinTransaction() method.
Specifies the primary table mapped by the annotated entity type.
Defines a primary key generator that may be referenced by name when a generator element is specified for the GeneratedValue annotation.
Used to group TableGenerator annotations.
Deprecated.
Newly-written code should use the date/time types defined in java.time.
Each instance represents a type of field which can be extracted from a date, time, or datetime.
Deprecated.
Newly-written code should use the date/time types defined in java.time.
Specifies a timeout for a database request.
Thrown by the persistence provider when a transaction is required but is not active.
Thrown by the persistence provider when a problem during class re-definition occurs.
Specifies that the annotated property or field is not persistent.
Interface for extracting the elements of a query result tuple.
The TupleElement interface defines an element that is returned in a query result tuple.
An instance of the type Type represents a persistent object or attribute type.
 
Interface used to control the execution of typed queries.
A reference to a named query declared via the NamedQuery or NamedNativeQuery annotations.
Specifies that a unique constraint is to be included in the generated DDL for a primary or secondary table.
The validation mode to be used by the provider for the persistence unit.
Declares the version field or property of an entity class, which is used to detect optimistic lock failures, ensuring the integrity of optimistic transactions.