All Classes
-
All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary Class Description AbstractQuery<T> TheAbstractQueryinterface 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 theAccessannotation 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> Interface implemented by custom attribute converters.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 orIdproperty or field.AttributeOverrides Used to override mappings of multiple properties or fields.Basic The simplest type of mapping of a persistent field or property to a single database column.BasicType<X> Bindable<T> An instances of the typeBindablerepresents an object or attribute type 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, and when the value of thepersistence.xmlcaching element isSharedCacheMode.ENABLE_SELECTIVEorSharedCacheMode.DISABLE_SELECTIVE.CacheRetrieveMode Specifies how theEntityManagerinteracts with the second-level cache when data is read from the database via theEntityManager.find(java.lang.Class<T>, java.lang.Object)methods and execution of queries.CacheStoreMode Specifies how theEntityManagerinteracts with the second-level cache when data is read from the database and when data is written to the database.CascadeType Defines the set of cascadable operations that are propagated to the associated entity.CheckConstraint Used to specify a SQL check constraint on a column or table when schema generation is in effect.ClassTransformer A persistence provider supplies an instance of this interface to thePersistenceUnitInfo.addTransformer(jakarta.persistence.spi.ClassTransformer)method.CollectionAttribute<X,E> Instances of the typeCollectionAttributerepresent persistentCollection-valued attributes.CollectionJoin<Z,E> TheCollectionJoininterface is the type of the result of joining to a collection over an association or element collection that has been specified as aCollection.CollectionTable Specifies the table that is used for the mapping of collections of basic or embeddable types.Column Specifies the column mapped by the annotated persistent property or field.ColumnResult Used in conjunction with theSqlResultSetMapping,NamedNativeQuery, orConstructorResultannotation to map a column of the SELECT list of a SQL query.CommonAbstractCriteria TheCommonAbstractCriteriainterface defines functionality that is common to both top-level criteria queries and subqueries as well as to update and delete criteria operations.CompoundSelection<X> TheCompoundSelectioninterface defines a compound selection item (a tuple, array, or result of a constructor).ConnectionConsumer<C> An executable action which makes use of a native database connection.ConnectionFunction<C,T> A function which makes use of a native database connection to compute a result.ConstraintMode Used to control the application of a constraint.ConstructorResult Used in conjunction with theSqlResultSetMappingorNamedNativeQueryannotation to map the SELECT clause of a SQL query to a constructor.Convert Specifies how the values of a field or property are converted to a basic type, enabling a converter definedautoApply=false, overriding the use of a converter definedautoApply=true, or overriding the use of a converter specified by a field or property of an embedded type or inherited mapped superclass.Converter Declares that the annotated class is a converter and specifies whether the converter is automatically applied.Converts Used to groupConvertannotations.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> TheCriteriaDeleteinterface defines functionality for performing bulk delete operations using the Criteria APICriteriaQuery<T> TheCriteriaQueryinterface defines functionality that is specific to top-level queries.CriteriaSelect<T> CriteriaUpdate<T> TheCriteriaUpdateinterface 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 the annotated entity type.ElementCollection Declares a collection of instances of a basic type or embeddable class.Embeddable Declares a type whose instances are stored as an intrinsic part of an owning entity, sharing the identity of the entity.EmbeddableType<X> An instance ofEmbeddableTyperepresents an embeddable type.Embedded Declares a persistent field or property of an entity whose value is an instance of an embeddable class.EmbeddedId Specifies that the annotated persistent field or property of an entity class or mapped superclass is the composite primary key of the entity.Entity Declares that the annotated 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 persistence unit, and to create new instances ofEntityManager.EntityNotFoundException Thrown by the persistence provider when an entity reference obtained byEntityManager.getReferenceis accessed but the entity does not exist.EntityResult Used in conjunction with theSqlResultSetMappingorNamedNativeQueryannotation 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> An instance ofEntityTyperepresents an entity type.Enumerated Specifies that a persistent property or field should be persisted as an enumerated type.EnumeratedValue Specifies that an annotated field of a Javaenumtype is the source of database column values for an enumerated mapping.EnumType Enumerates available options for mapping 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 theEntityResultannotation to map columns specified in the SELECT list of a SQL query to the properties or fields of an entity class.FindOption An option influencing the behavior ofEntityManager.find(java.lang.Class<T>, java.lang.Object).FlushModeType Enumerates flush modes recognized by theEntityManager.ForeignKey Specifies 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 Specifies a generation strategy for generated primary keys.GenerationType Enumerates the defined primary key generation strategies.Graph<T> Declares operations common toEntityGraphandSubgraph.Id Identifies the primary key of an entity.IdClass Specifies a composite primary key type whose fields or properties map to the identifier fields or properties of the annotated entity class.IdentifiableType<X> An instance of the typeIdentifiableTyperepresents an entity or mapped superclass type.Index Used in schema generation to specify creation of an index.Inheritance Specifies the inheritance mapping strategy for the entity class hierarchy which descends from the annotated entity class.InheritanceType Enumerated the options for mapping entity inheritance.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 an association to an intermediate join table.JoinType Defines the three varieties of join.ListAttribute<X,E> Instances of the typeListAttributerepresent persistentList-valued attributes.ListJoin<Z,E> TheListJoininterface is the type of the result of joining to a collection over an association or element collection that has been specified as aList.LoadState Load states returned by theProviderUtilSPI methods.Lob Specifies that the annotated persistent property or field should be persisted as a large object to a database-native large object (LOB) type.LocalDateField<N> Each instance represents a type of field which can be extracted from aLocalDate.LocalDateTimeField<N> Each instance represents a type of field which can be extracted from aLocalDateTime.LocalTimeField<N> Each instance represents a type of field which can be extracted from aLocalTime.LockModeType Enumerates the kinds of optimistic or pessimistic lock which may be obtained on an entity instance.LockOption An option influencing the behavior ofEntityManager.lock(java.lang.Object, jakarta.persistence.LockModeType).LockTimeoutException Thrown by the persistence provider when a pessimistic locking conflict occurs that does not result in transaction rollback.ManagedType<X> Instances of the typeManagedTyperepresent entity, mapped superclass, and embeddable types.ManyToMany Specifies a many-valued association with many-to-many multiplicity, mapping to an intermediate table called the join table.ManyToOne Specifies a single-valued association to another entity class that has many-to-one multiplicity.MapAttribute<X,K,V> Instances of the typeMapAttributerepresent persistentMap-valued attributes.MapJoin<Z,K,V> TheMapJoininterface is the type of the result of joining to a collection over an association or element collection that has been specified as aMap.MapKey Specifies the map key for associations of typeMapwhen 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 typeMap.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 Deprecated. Newly-written code should use the date/time types defined injava.time.MappedSuperclass Declares a class which is not itself an entity, but whose mappings are inherited by the entities which extend it.MappedSuperclassType<X> An instance of the typeMappedSuperclassTyperepresents a mapped superclass type.MapsId Designates aManyToOneorOneToOnerelationship attribute that provides the mapping for anEmbeddedIdprimary key, an attribute within anEmbeddedIdprimary key, or a simple primary key of the parent entity.Metamodel Provides access to the metamodel of persistent entities in the persistence unit.NamedAttributeNode ANamedAttributeNodeis a member element of aNamedEntityGraph.NamedEntityGraph Defines a named entity graph.NamedEntityGraphs Used to groupNamedEntityGraphannotations.NamedNativeQueries Declares multiple native SQL named queries.NamedNativeQuery Declares a named native SQL query and, optionally, the mapping of the result of the native SQL query.NamedQueries Declares multiple named Jakarta Persistence query language queries.NamedQuery Declares a named query written in the Jakarta Persistence query language.NamedStoredProcedureQueries Specifies multiple named stored procedure queries.NamedStoredProcedureQuery Declares and names a stored procedure, its parameters, and its result type.NamedSubgraph ANamedSubgraphis a member element of aNamedEntityGraph.NonUniqueResultException Thrown by the persistence provider whenQuery.getSingleResult()orTypedQuery.getSingleResult()is executed and there is more than one result from the query.NoResultException Thrown by the persistence provider whenQuery.getSingleResult()orTypedQuery.getSingleResult()is executed and there is no result to return.Nulls Specifies the precedence of null values within query result sets.OneToMany Specifies a many-valued association with one-to-many multiplicity.OneToOne Specifies a single-valued association to another entity class 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 used to obtain anEntityManagerFactoryin Java SE environments.PersistenceConfiguration Represents a configuration of a persistence unit, allowing programmatic creation of anEntityManagerFactory.PersistenceContext Expresses a dependency on a container-managedEntityManagerand its associated persistence context.PersistenceContexts Declares one or morePersistenceContextannotations.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 Provides a list of persistence providers available in the runtime environment.PersistenceProviderResolverHolder Holds the globalPersistenceProviderResolverinstance.PersistenceUnit Expresses a dependency on anEntityManagerFactoryand its associated persistence unit.PersistenceUnitInfo Interface implemented by the container and used by the persistence provider when creating anEntityManagerFactory.PersistenceUnits Declares one or morePersistenceUnitannotations.PersistenceUnitTransactionType Enumerates the possible approaches to transaction management in Jakarta Persistence.PersistenceUnitTransactionType Deprecated, for removal: This API element is subject to removal in a future version. replaced byPersistenceUnitTransactionTypePersistenceUnitUtil 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 a pessimistic locking conflict occurs.PessimisticLockScope Defines the values of thejakarta.persistence.lock.scopeproperty for pessimistic locking.PluralAttribute<X,C,E> Instances of the typePluralAttributerepresent persistent collection-valued attributes.PluralAttribute.CollectionType PluralJoin<Z,C,E> ThePluralJoininterface 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 GroupsPrimaryKeyJoinColumnannotations.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 theNamedQueryorNamedNativeQueryannotation.QueryTimeoutException Thrown by the persistence provider when a query times out and only the statement is rolled back.RefreshOption An option influencing the behavior ofEntityManager.refresh(java.lang.Object).RollbackException Thrown by the persistence provider whenEntityTransaction.commit()fails.Root<X> A root type in the from clause.SchemaManager Allows programmatic schema creation, schema validation, data cleanup, and schema cleanup for entities belonging to a certain persistence unit.SchemaValidationException Thrown whenschema validationfails.SecondaryTable Specifies a secondary table for the annotated entity class.SecondaryTables Specifies multiple secondary tables for an entity.Selection<X> TheSelectioninterface 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 theGeneratedValueannotation.SequenceGenerators Used to groupSequenceGeneratorannotations.SetAttribute<X,E> Instances of the typeSetAttributerepresent persistentSet-valued attributes.SetJoin<Z,E> TheSetJoininterface is the type of the result of joining to a collection over an association or element collection that has been specified as aSet.SharedCacheMode Specifies how the provider must use a second-level cache for the persistence unit.SingularAttribute<X,T> Instances of the typeSingularAttributerepresents persistent single-valued properties or fields.SqlResultSetMapping Specifies a mapping of the columns of a result set of a native SQL query or stored procedure.SqlResultSetMappings Used to define one or moreSqlResultSetMappingannotations.StaticMetamodel TheStaticMetamodelannotation specifies that the class is a metamodel class that represents the entity, mapped superclass, or embeddable class designated by theStaticMetamodel.value()element.StoredProcedureParameter Declares 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> TheSubqueryinterface 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 mapped by the annotated entity type.TableGenerator Defines a primary key generator that may be referenced by name when a generator element is specified for theGeneratedValueannotation.TableGenerators Used to groupTableGeneratorannotations.Temporal Deprecated. Newly-written code should use the date/time types defined injava.time.TemporalField<N,T extends Temporal> Each instance represents a type of field which can be extracted from a date, time, or datetime.TemporalType Deprecated. Newly-written code should use the date/time types defined injava.time.Timeout Specifies a timeout for a database request.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 annotated property or field is not persistent.Tuple Interface for extracting the elements of a query result tuple.TupleElement<X> TheTupleElementinterface defines an element that is returned in a query result tuple.Type<X> An instance of the typeTyperepresents a persistent object or attribute type.Type.PersistenceType TypedQuery<X> Interface used to control the execution of typed queries.TypedQueryReference<R> A reference to a named query declared via theNamedQueryorNamedNativeQueryannotations.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 Declares the version field or property of an entity class, which is used to detect optimistic lock failures, ensuring the integrity of optimistic transactions.