Java(TM) Persistence API
PERSISTENCE - 1.0
JavaDoc Assertion Detail

TotalsTotalActiveDeprecatedRemoved
# of Assertions 24124100
# of Required Assertions 22522500
# of Optional Assertions 161600

IDReturnMethod/FieldDescriptionRequiredDeprecatedTestable
PERSISTENCE:JAVADOC:1JoinColumn[]jakarta.persistence.AssociationOverride.joinColumns
The join column that is being mapped to the persistent attribute. The mapping type will remain the same as is defined in the mapped superclass. true
true
PERSISTENCE:JAVADOC:2Stringjakarta.persistence.AssociationOverride.name
The name of the relationship property whose mapping is being overridden if property-based access is being used, or the name of the relationship field if field-based access is used. true
true
PERSISTENCE:JAVADOC:3AssociationOverride[]jakarta.persistence.AssociationOverrides.value
Mapping overrides of relationship properties or fields true
true
PERSISTENCE:JAVADOC:4Columnjakarta.persistence.AttributeOverride.column
(Required) The column that is being mapped to the persistent attribute. The mapping type will remain the same as is defined in the embeddable class or mapped superclass. true
true
PERSISTENCE:JAVADOC:5Stringjakarta.persistence.AttributeOverride.name
(Required) The name of the property whose mapping is being overridden if property-based access is being used, or the name of the field if field-based access is used. true
true
PERSISTENCE:JAVADOC:6AttributeOverride[]jakarta.persistence.AttributeOverrides.value
One or more mapping override true
true
PERSISTENCE:JAVADOC:7FetchTypejakarta.persistence.Basic.fetch
(Optional) Defines whether the value of the field or property should be lazily loaded or must be eagerly fetched. The EAGER strategy is a requirement on the persistence provider runtime that the value must be eagerly fetched. The LAZY strategy is a hint to the persistence provider runtime. If not specified, defaults to EAGER. true
true
PERSISTENCE:JAVADOC:8booleanjakarta.persistence.Basic.optional
(Optional) Defines whether the value of the field or property may be null. This is a hint and is disregarded for primitive types; it may be used in schema generation. If not specified, defaults to true. true
true
PERSISTENCE:JAVADOC:9CascadeTypejakarta.persistence.CascadeType.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:10CascadeType[]jakarta.persistence.CascadeType.values

true
true
PERSISTENCE:JAVADOC:11Stringjakarta.persistence.Column.columnDefinition
(Optional) The SQL fragment that is used when generating the DDL for the column. Defaults to the generated SQL to create a column of the inferred type. false
true
PERSISTENCE:JAVADOC:12booleanjakarta.persistence.Column.insertable
(Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider. false
true
PERSISTENCE:JAVADOC:13intjakarta.persistence.Column.length
(Optional) The column length. (Applies only if a string-valued column is used.) false
true
PERSISTENCE:JAVADOC:14Stringjakarta.persistence.Column.name
(Optional) The name of the column. Defaults to the property or field name. true
true
PERSISTENCE:JAVADOC:15booleanjakarta.persistence.Column.nullable
Optional) Whether the database column is nullable. true
true
PERSISTENCE:JAVADOC:16intjakarta.persistence.Column.precision
(Optional) The precision for a decimal (exact numeric) column. (Applies only if a decimal column is used.) Value must be set by developer if used when generating the DDL for the column. false
true
PERSISTENCE:JAVADOC:17intjakarta.persistence.Column.scale
(Optional) The scale for a decimal (exact numeric) column. (Applies only if a decimal column is used.) false
true
PERSISTENCE:JAVADOC:18Stringjakarta.persistence.Column.table
(Optional) The name of the table that contains the column. If absent the column is assumed to be in the primary table. false
true
PERSISTENCE:JAVADOC:19booleanjakarta.persistence.Column.unique
(Optional) Whether the property is a unique key. This is a shortcut for the UniqueConstraint annotation at the table level and is useful for when the unique key constraint is only a single field. This constraint applies in addition to any constraint entailed by primary key mapping and to constraints specified at the table level. false
true
PERSISTENCE:JAVADOC:20booleanjakarta.persistence.Column.updatable
(Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider. true
true
PERSISTENCE:JAVADOC:21Stringjakarta.persistence.ColumnResult.name
The name of a column in the SELECT clause of a SQL query true
true
PERSISTENCE:JAVADOC:22Stringjakarta.persistence.DiscriminatorColumn.columnDefinition
(Optional) The SQL fragment that is used when generating the DDL for the discriminator column. Defaults to the provider-generated SQL to create a column of the specified discriminator type. false
true
PERSISTENCE:JAVADOC:23DiscriminatorTypejakarta.persistence.DiscriminatorColumn.discriminatorType
(Optional) The type of object/column to use as a class discriminator. Defaults to DiscriminatorType#STRING DiscriminatorType.STRING. true
true
PERSISTENCE:JAVADOC:24intjakarta.persistence.DiscriminatorColumn.length
(Optional) The column length for String-based discriminator types. Ignored for other discriminator types. false
true
PERSISTENCE:JAVADOC:25Stringjakarta.persistence.DiscriminatorColumn.name
(Optional) The name of column to be used for the discriminator. false
true
PERSISTENCE:JAVADOC:26DiscriminatorTypejakarta.persistence.DiscriminatorType.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:27DiscriminatorType[]jakarta.persistence.DiscriminatorType.values

true
true
PERSISTENCE:JAVADOC:28Stringjakarta.persistence.DiscriminatorValue.value
(Optional) The value that indicates that the row is an entity of the annotated entity type. If the DiscriminatorValue annotation is not specified and a discriminator column is used, a provider-specific function will be used to generate a value representing the entity type. If the DiscriminatorType is DiscriminatorType#STRING STRING, the discriminator value default is the entity name. true
true
PERSISTENCE:JAVADOC:29Stringjakarta.persistence.Entity.name
The name of an entity. Defaults to the unqualified name of the entity class. This name is used to refer to the entity in queries. The name must not be a reserved literal in the Java Persistence query language. true
true
PERSISTENCE:JAVADOC:30EntityExistsExceptionjakarta.persistence.EntityExistsException.EntityExistsException
Constructs a new EntityExistsException exception with null as its detail message. true
true
PERSISTENCE:JAVADOC:31EntityExistsExceptionjakarta.persistence.EntityExistsException.EntityExistsException
( String )
Constructs a new EntityExistsException exception with the specified detail message. true
true
PERSISTENCE:JAVADOC:32EntityExistsExceptionjakarta.persistence.EntityExistsException.EntityExistsException
( String ,
Throwable )
Constructs a new EntityExistsException exception with the specified detail message and cause. true
true
PERSISTENCE:JAVADOC:33EntityExistsExceptionjakarta.persistence.EntityExistsException.EntityExistsException
( Throwable )
Constructs a new EntityExistsException exception with the specified cause. true
true
PERSISTENCE:JAVADOC:34Class[]jakarta.persistence.EntityListeners.value
The callback listener classes true
true
PERSISTENCE:JAVADOC:35voidjakarta.persistence.EntityManager.clear
Clear the persistence context, causing all managed entities to become detached. Changes made to entities that have not been flushed to the database will not be persisted. true
true
PERSISTENCE:JAVADOC:36voidjakarta.persistence.EntityManager.close
Close an application-managed EntityManager. After the close method has been invoked, all methods on the EntityManager instance and any Query objects obtained from it will throw the IllegalStateException except for getTransaction and isOpen (which will return false). If this method is called when the EntityManager is associated with an active transaction, the persistence context remains managed until the transaction completes. true
true
PERSISTENCE:JAVADOC:37booleanjakarta.persistence.EntityManager.contains
( Object )
Check if the instance belongs to the current persistence context. true
true
PERSISTENCE:JAVADOC:38Queryjakarta.persistence.EntityManager.createNamedQuery
( String )
Create an instance of Query for executing a named query (in the Java Persistence query language or in native SQL). true
true
PERSISTENCE:JAVADOC:39Queryjakarta.persistence.EntityManager.createNativeQuery
( String )
Create an instance of Query for executing a native SQL statement, e.g., for update or delete. true
true
PERSISTENCE:JAVADOC:40Queryjakarta.persistence.EntityManager.createNativeQuery
( String ,
Class )
Create an instance of Query for executing a native SQL query. true
true
PERSISTENCE:JAVADOC:41Queryjakarta.persistence.EntityManager.createNativeQuery
( String ,
String )
Create an instance of Query for executing a native SQL query. true
true
PERSISTENCE:JAVADOC:42Queryjakarta.persistence.EntityManager.createQuery
( String )
Create an instance of Query for executing a Java Persistence query language statement. true
true
PERSISTENCE:JAVADOC:43Objectjakarta.persistence.EntityManager.find
( Class ,
Object )
Find by primary key. true
true
PERSISTENCE:JAVADOC:44voidjakarta.persistence.EntityManager.flush
Synchronize the persistence context to the underlying database. true
true
PERSISTENCE:JAVADOC:45Objectjakarta.persistence.EntityManager.getDelegate
Return the underlying provider object for the EntityManager, if available. The result of this method is implementation specific. true
false
PERSISTENCE:JAVADOC:46FlushModeTypejakarta.persistence.EntityManager.getFlushMode
Get the flush mode that applies to all objects contained in the persistence context. true
true
PERSISTENCE:JAVADOC:47Objectjakarta.persistence.EntityManager.getReference
( Class ,
Object )
Get an instance, whose state may be lazily fetched. If the requested instance does not exist in the database, throws EntityNotFoundException when the instance state is first accessed. (The persistence provider runtime is permitted to throw EntityNotFoundException when #getReference is called.) The application should not expect that the instance state will be available upon detachment, unless it was accessed by the application while the entity manager was open. true
true
PERSISTENCE:JAVADOC:48EntityTransactionjakarta.persistence.EntityManager.getTransaction
Returns the resource-level transaction object. The EntityTransaction instance may be used serially to begin and commit multiple transactions. true
true
PERSISTENCE:JAVADOC:49booleanjakarta.persistence.EntityManager.isOpen
Determine whether the EntityManager is open. true
true
PERSISTENCE:JAVADOC:50voidjakarta.persistence.EntityManager.joinTransaction
Indicate to the EntityManager that a JTA transaction is active. This method should be called on a JTA application managed EntityManager that was created outside the scope of the active transaction to associate it with the current JTA transaction. true
true
PERSISTENCE:JAVADOC:51voidjakarta.persistence.EntityManager.lock
( Object ,
LockModeType )
Set the lock mode for an entity object contained in the persistence context. true
true
PERSISTENCE:JAVADOC:52Objectjakarta.persistence.EntityManager.merge
( Object )
Merge the state of the given entity into the current persistence context. true
true
PERSISTENCE:JAVADOC:53voidjakarta.persistence.EntityManager.persist
( Object )
Make an entity instance managed and persistent. true
true
PERSISTENCE:JAVADOC:54voidjakarta.persistence.EntityManager.refresh
( Object )
Refresh the state of the instance from the database, overwriting changes made to the entity, if any. true
true
PERSISTENCE:JAVADOC:55voidjakarta.persistence.EntityManager.remove
( Object )
Remove the entity instance. true
true
PERSISTENCE:JAVADOC:56voidjakarta.persistence.EntityManager.setFlushMode
( FlushModeType )
Set the flush mode that applies to all objects contained in the persistence context. true
true
PERSISTENCE:JAVADOC:57voidjakarta.persistence.EntityManagerFactory.close
Close the factory, releasing any resources that it holds. After a factory instance is closed, all methods invoked on it will throw an IllegalStateException, except for isOpen, which will return false. Once an EntityManagerFactory has been closed, all its entity managers are considered to be in the closed state. true
true
PERSISTENCE:JAVADOC:58EntityManagerjakarta.persistence.EntityManagerFactory.createEntityManager
Create a new EntityManager. This method returns a new EntityManager instance each time it is invoked. The isOpen method will return true on the returned instance. true
true
PERSISTENCE:JAVADOC:59EntityManagerjakarta.persistence.EntityManagerFactory.createEntityManager
( Map )
Create a new EntityManager with the specified Map of properties. This method returns a new EntityManager instance each time it is invoked. The isOpen method will return true on the returned instance. true
true
PERSISTENCE:JAVADOC:60booleanjakarta.persistence.EntityManagerFactory.isOpen
Indicates whether or not this factory is open. Returns true until a call to close has been made. true
true
PERSISTENCE:JAVADOC:61EntityNotFoundExceptionjakarta.persistence.EntityNotFoundException.EntityNotFoundException
Constructs a new EntityNotFoundException exception with null as its detail message. true
true
PERSISTENCE:JAVADOC:62EntityNotFoundExceptionjakarta.persistence.EntityNotFoundException.EntityNotFoundException
( String )
Constructs a new EntityNotFoundException exception with the specified detail message. true
true
PERSISTENCE:JAVADOC:63Stringjakarta.persistence.EntityResult.discriminatorColumn
Specifies the column name (or alias) of the column in the SELECT list that is used to determine the type of the entity instance. true
true
PERSISTENCE:JAVADOC:64Classjakarta.persistence.EntityResult.entityClass
The class of the result true
true
PERSISTENCE:JAVADOC:65FieldResult[]jakarta.persistence.EntityResult.fields
Maps the columns specified in the SELECT list of the query to the properties or fields of the entity class. true
true
PERSISTENCE:JAVADOC:66voidjakarta.persistence.EntityTransaction.begin
Start the resource transaction. true
true
PERSISTENCE:JAVADOC:67voidjakarta.persistence.EntityTransaction.commit
Commit the current transaction, writing any unflushed changes to the database. true
true
PERSISTENCE:JAVADOC:68booleanjakarta.persistence.EntityTransaction.getRollbackOnly
Determine whether the current transaction has been marked for rollback. true
true
PERSISTENCE:JAVADOC:69booleanjakarta.persistence.EntityTransaction.isActive
Indicate whether a transaction is in progress. true
true
PERSISTENCE:JAVADOC:70voidjakarta.persistence.EntityTransaction.rollback
Roll back the current transaction true
true
PERSISTENCE:JAVADOC:71voidjakarta.persistence.EntityTransaction.setRollbackOnly
Mark the current transaction so that the only possible outcome of the transaction is for the transaction to be rolled back. true
true
PERSISTENCE:JAVADOC:72EnumTypejakarta.persistence.Enumerated.value
(Optional) The type used in mapping an enum type. true
true
PERSISTENCE:JAVADOC:73EnumTypejakarta.persistence.EnumType.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:74EnumType[]jakarta.persistence.EnumType.values

true
true
PERSISTENCE:JAVADOC:75FetchTypejakarta.persistence.FetchType.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:76FetchType[]jakarta.persistence.FetchType.values

true
true
PERSISTENCE:JAVADOC:77Stringjakarta.persistence.FieldResult.column
Name of the column in the SELECT clause - i.e., column aliases, if applicable. true
true
PERSISTENCE:JAVADOC:78Stringjakarta.persistence.FieldResult.name
Name of the persistent field or property of the class. true
true
PERSISTENCE:JAVADOC:79FlushModeTypejakarta.persistence.FlushModeType.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:80FlushModeType[]jakarta.persistence.FlushModeType.values

true
true
PERSISTENCE:JAVADOC:81Stringjakarta.persistence.GeneratedValue.generator
(Optional) The name of the primary key generator to use as specified in the SequenceGenerator or TableGenerator annotation. Defaults to the id generator supplied by persistence provider. true
true
PERSISTENCE:JAVADOC:82GenerationTypejakarta.persistence.GeneratedValue.strategy
(Optional) The primary key generation strategy that the persistence provider must use to generate the annotated entity primary key. true
true
PERSISTENCE:JAVADOC:83GenerationTypejakarta.persistence.GenerationType.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:84GenerationType[]jakarta.persistence.GenerationType.values

true
true
PERSISTENCE:JAVADOC:85Classjakarta.persistence.IdClass.value
Primary key class true
true
PERSISTENCE:JAVADOC:86InheritanceTypejakarta.persistence.Inheritance.strategy
The strategy to be used true
true
PERSISTENCE:JAVADOC:87InheritanceTypejakarta.persistence.InheritanceType.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:88InheritanceType[]jakarta.persistence.InheritanceType.values

true
true
PERSISTENCE:JAVADOC:89Stringjakarta.persistence.JoinColumn.columnDefinition
(Optional) The SQL fragment that is used when generating the DDL for the column. Defaults to the generated SQL for the column. false
true
PERSISTENCE:JAVADOC:90booleanjakarta.persistence.JoinColumn.insertable
(Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider. true
true
PERSISTENCE:JAVADOC:91Stringjakarta.persistence.JoinColumn.name
(Optional) The name of the foreign key column. The table in which it is found depends upon the context. If the join is for a OneToOne or Many- ToOne mapping, the foreign key column is in the table of the source entity. If the join is for a ManyToMany, the foreign key is in a join table. Default (only applies if a single join column is used): The concatenation of the following: the name of the referencing relationship property or field of the referencing entity; "_"; the name of the referenced primary key column. If there is no such referencing relationship property or field in the entity, the join column name is formed as the concatenation of the following: the name of the entity; "_"; the name of the referenced primary key column. true
true
PERSISTENCE:JAVADOC:92booleanjakarta.persistence.JoinColumn.nullable
(Optional) Whether the foreign key column is nullable. true
true
PERSISTENCE:JAVADOC:93Stringjakarta.persistence.JoinColumn.referencedColumnName
(Optional) The name of the column referenced by this foreign key column. When used with relationship mappings, the referenced column is in the table of the target entity. When used inside a JoinTable annotation, the referenced key column is in the entity table of the owning entity, or inverse entity if the join is part of the inverse join definition. Default (only applies if single join column is being used): The same name as the primary key column of the referenced table. true
true
PERSISTENCE:JAVADOC:94Stringjakarta.persistence.JoinColumn.table
(Optional) The name of the table that contains the column. If a table is not specified, the column is assumed to be in the primary table of the applicable entity. true
true
PERSISTENCE:JAVADOC:95booleanjakarta.persistence.JoinColumn.unique
(Optional) Whether the property is a unique key. This is a shortcut for the UniqueConstraint annotation at the table level and is useful for when the unique key constraint is only a single field. It is not necessary to explicitly specify this for a join column that corresponds to a primary key that is part of a foreign key. false
true
PERSISTENCE:JAVADOC:96booleanjakarta.persistence.JoinColumn.updatable
(Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider. true
true
PERSISTENCE:JAVADOC:97JoinColumn[]jakarta.persistence.JoinColumns.value

true
true
PERSISTENCE:JAVADOC:98Stringjakarta.persistence.JoinTable.catalog
(Optional) The catalog of the table. Defaults to the default catalog. true
true
PERSISTENCE:JAVADOC:99JoinColumn[]jakarta.persistence.JoinTable.inverseJoinColumns
(Optional) The foreign key columns of the join table which reference the primary table of the entity that does not own the association (i.e. the inverse side of the association). Uses the same defaults as for JoinColumn. true
true
PERSISTENCE:JAVADOC:100JoinColumn[]jakarta.persistence.JoinTable.joinColumns
(Optional) The foreign key columns of the join table which reference the primary table of the entity owning the association (i.e. the owning side of the association). Uses the same defaults as for JoinColumn. true
true
PERSISTENCE:JAVADOC:101Stringjakarta.persistence.JoinTable.name
(Optional) The name of the join table. Defaults to the concatenated names of the two associated primary entity tables, separated by an underscore. true
true
PERSISTENCE:JAVADOC:102Stringjakarta.persistence.JoinTable.schema
(Optional) The schema of the table. Defaults to the default schema for user. true
true
PERSISTENCE:JAVADOC:103UniqueConstraint[]jakarta.persistence.JoinTable.uniqueConstraints
(Optional) Unique constraints that are to be placed on the table. These are only used if table generation is in effect. Defaults to no additional constraints. false
true
PERSISTENCE:JAVADOC:104LockModeTypejakarta.persistence.LockModeType.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:105LockModeType[]jakarta.persistence.LockModeType.values

true
true
PERSISTENCE:JAVADOC:106CascadeType[]jakarta.persistence.ManyToMany.cascade
(Optional) The operations that must be cascaded to the target of the association. Defaults to no operations being cascaded. true
true
PERSISTENCE:JAVADOC:107FetchTypejakarta.persistence.ManyToMany.fetch
(Optional) Whether the association should be lazily loaded or must be eagerly fetched. The FetchType#EAGER EAGER strategy is a requirement on the persistenceprovider runtime that the associatedentities must be eagerly fetched. The FetchType#LAZY LAZY strategy is a hint to the persistence provider runtime. true
true
PERSISTENCE:JAVADOC:108Stringjakarta.persistence.ManyToMany.mappedBy
The field that owns the relationship. Required unless the relationship is unidirectional. true
true
PERSISTENCE:JAVADOC:109Classjakarta.persistence.ManyToMany.targetEntity
(Optional) The entity class that is the target of the association. Optional only if the collection property is defined using Java generics. Must be specified otherwise. Defaults to the parameterized type of the collection when defined using generics. true
true
PERSISTENCE:JAVADOC:110CascadeType[]jakarta.persistence.ManyToOne.cascade
(Optional) The operations that must be cascaded to the target of the association. By default no operations are cascaded. true
true
PERSISTENCE:JAVADOC:111FetchTypejakarta.persistence.ManyToOne.fetch
(Optional) Whether the association should be lazily loaded or must be eagerly fetched. The FetchType#EAGER EAGER strategy is a requirement on the persistence provider runtime that the associated entity must be eagerly fetched. The FetchType#LAZY LAZY strategy is a hint to the persistence provider runtime. true
true
PERSISTENCE:JAVADOC:112booleanjakarta.persistence.ManyToOne.optional
(Optional) Whether the association is optional. If set to false then a non-null relationship must always exist. true
true
PERSISTENCE:JAVADOC:113Classjakarta.persistence.ManyToOne.targetEntity
(Optional) The entity class that is the target of the association. Defaults to the type of the field or property that stores the association. true
true
PERSISTENCE:JAVADOC:114Stringjakarta.persistence.MapKey.name
The name of the persistent field or property of the associated entity that is used as the map key. If the name element is not specified, the primary key of the associated entity is used as the map key. If the primary key is a composite primary key and is mapped as IdClass, an instance of the primary key class is used as the key. true
true
PERSISTENCE:JAVADOC:115NamedNativeQuery[]jakarta.persistence.NamedNativeQueries.value
Array of native SQL named queries true
true
PERSISTENCE:JAVADOC:116QueryHint[]jakarta.persistence.NamedNativeQuery.hints
Vendor-specific query hints true
false
PERSISTENCE:JAVADOC:117Stringjakarta.persistence.NamedNativeQuery.name
Is used to refer to the query when using the EntityManager methods that create query objects. true
true
PERSISTENCE:JAVADOC:118Stringjakarta.persistence.NamedNativeQuery.query
The SQL query string true
true
PERSISTENCE:JAVADOC:119Classjakarta.persistence.NamedNativeQuery.resultClass
The class of the result true
true
PERSISTENCE:JAVADOC:120Stringjakarta.persistence.NamedNativeQuery.resultSetMapping
The name of a SqlResultSetMapping, as defined in metadata true
true
PERSISTENCE:JAVADOC:121NamedQuery[]jakarta.persistence.NamedQueries.value
An array of named Java Persistence query language queries. true
true
PERSISTENCE:JAVADOC:122QueryHint[]jakarta.persistence.NamedQuery.hints
Vendor-specific query hints true
false
PERSISTENCE:JAVADOC:123Stringjakarta.persistence.NamedQuery.name
Refers to the query when using the EntityManager methods that create query objects. true
true
PERSISTENCE:JAVADOC:124Stringjakarta.persistence.NamedQuery.query
The query string in the Java Persistence query language true
true
PERSISTENCE:JAVADOC:125NonUniqueResultExceptionjakarta.persistence.NonUniqueResultException.NonUniqueResultException
Constructs a new NonUniqueResultException exception with null as its detail message. true
true
PERSISTENCE:JAVADOC:126NonUniqueResultExceptionjakarta.persistence.NonUniqueResultException.NonUniqueResultException
( String )
Constructs a new NonUniqueResultException exception with the specified detail message. true
true
PERSISTENCE:JAVADOC:127NoResultExceptionjakarta.persistence.NoResultException.NoResultException
Constructs a new NoResultException exception with null as its detail message. true
true
PERSISTENCE:JAVADOC:128NoResultExceptionjakarta.persistence.NoResultException.NoResultException
( String )
Constructs a new NoResultException exception with the specified detail message. true
true
PERSISTENCE:JAVADOC:129CascadeType[]jakarta.persistence.OneToMany.cascade
(Optional) The operations that must be cascaded to the target of the association. Defaults to no operations being cascaded. true
true
PERSISTENCE:JAVADOC:130FetchTypejakarta.persistence.OneToMany.fetch
(Optional) Whether the association should be lazily loaded or must be eagerly fetched. The FetchType#EAGER EAGER strategy is a requirement on the persistenceprovider runtime that the associatedentities must be eagerly fetched. The FetchType#LAZY LAZY strategy is a hint to the persistence provider runtime. true
true
PERSISTENCE:JAVADOC:131Stringjakarta.persistence.OneToMany.mappedBy
The field that owns the relationship. Required unless the relationship is unidirectional. true
true
PERSISTENCE:JAVADOC:132Classjakarta.persistence.OneToMany.targetEntity
(Optional) The entity class that is the target of the association. Optional only if the collection property is defined using Java generics. Must be specified otherwise. Defaults to the parameterized type of the collection when defined using generics. true
true
PERSISTENCE:JAVADOC:133CascadeType[]jakarta.persistence.OneToOne.cascade
(Optional) The operations that must be cascaded to the target of the association. By default no operations are cascaded. true
true
PERSISTENCE:JAVADOC:134FetchTypejakarta.persistence.OneToOne.fetch
(Optional) Whether the association should be lazily loaded or must be eagerly fetched. The FetchType#EAGER EAGER strategy is a requirement on the persistence provider runtime that the associated entity must be eagerly fetched. The FetchType#LAZY LAZY strategy is a hint to the persistence provider runtime. true
true
PERSISTENCE:JAVADOC:135Stringjakarta.persistence.OneToOne.mappedBy
(Optional) The field that owns the relationship. This element is only specified on the inverse (non-owning) side of the association. true
true
PERSISTENCE:JAVADOC:136booleanjakarta.persistence.OneToOne.optional
(Optional) Whether the association is optional. If set to false then a non-null relationship must always exist. true
true
PERSISTENCE:JAVADOC:137Classjakarta.persistence.OneToOne.targetEntity
(Optional) The entity class that is the target of the association. Defaults to the type of the field or property that stores the association. true
true
PERSISTENCE:JAVADOC:138Objectjakarta.persistence.OptimisticLockException.getEntity
Returns the entity that caused this exception. true
true
PERSISTENCE:JAVADOC:139OptimisticLockExceptionjakarta.persistence.OptimisticLockException.OptimisticLockException
Constructs a new OptimisticLockException exception with null as its detail message. true
true
PERSISTENCE:JAVADOC:140OptimisticLockExceptionjakarta.persistence.OptimisticLockException.OptimisticLockException
( String )
Constructs a new OptimisticLockException exception with the specified detail message. true
true
PERSISTENCE:JAVADOC:141OptimisticLockExceptionjakarta.persistence.OptimisticLockException.OptimisticLockException
( String ,
Throwable )
Constructs a new OptimisticLockException exception with the specified detail message and cause. true
true
PERSISTENCE:JAVADOC:142OptimisticLockExceptionjakarta.persistence.OptimisticLockException.OptimisticLockException
( Throwable )
Constructs a new OptimisticLockException exception with the specified cause. true
true
PERSISTENCE:JAVADOC:143OptimisticLockExceptionjakarta.persistence.OptimisticLockException.OptimisticLockException
( Object )
Constructs a new OptimisticLockException exception with the specified entity. true
true
PERSISTENCE:JAVADOC:144OptimisticLockExceptionjakarta.persistence.OptimisticLockException.OptimisticLockException
( String ,
Throwable ,
Object )
Constructs a new OptimisticLockException exception with the specified detail message, cause, and entity. true
true
PERSISTENCE:JAVADOC:145Stringjakarta.persistence.OrderBy.value
An orderby_list, specified as follows: orderby_list::= orderby_item [,orderby_item]* orderby_item::= property_or_field_name [ASC | DESC] If ASC or DESC is not specified, ASC (ascending order) is assumed. If the ordering element is not specified, ordering by the primary key of the associated entity is assumed. true
true
PERSISTENCE:JAVADOC:146EntityManagerFactoryjakarta.persistence.Persistence.createEntityManagerFactory
( String )
Create and return an EntityManagerFactory for the named persistence unit. true
false
PERSISTENCE:JAVADOC:147EntityManagerFactoryjakarta.persistence.Persistence.createEntityManagerFactory
( String ,
Map )
Create and return an EntityManagerFactory for the named persistence unit using the given properties. true
false
PERSISTENCE:JAVADOC:148Persistencejakarta.persistence.Persistence.Persistence

true
false
PERSISTENCE:JAVADOC:149Stringjakarta.persistence.PersistenceContext.name
The name by which the entity manager is to be accessed in the environment referencing context, and is not needed when dependency injection is used. true
true
PERSISTENCE:JAVADOC:150PersistenceProperty[]jakarta.persistence.PersistenceContext.properties
Used to specify properties for the container or persistence provider. Vendor specific properties may be included in this set of properties. Properties that are not recognized by a vendor are ignored. true
false
PERSISTENCE:JAVADOC:151PersistenceContextTypejakarta.persistence.PersistenceContext.type
Specifies whether this is a transaction-scoped persistence context or an extended persistence context. true
true
PERSISTENCE:JAVADOC:152Stringjakarta.persistence.PersistenceContext.unitName
The name of the persistence unit. If the unitName element is specified, the persistence unit for the entity manager that is accessible in JNDI must have the same name. true
true
PERSISTENCE:JAVADOC:153PersistenceContext[]jakarta.persistence.PersistenceContexts.value
One or more persistence context true
true
PERSISTENCE:JAVADOC:154PersistenceContextTypejakarta.persistence.PersistenceContextType.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:155PersistenceContextType[]jakarta.persistence.PersistenceContextType.values

true
true
PERSISTENCE:JAVADOC:156PersistenceExceptionjakarta.persistence.PersistenceException.PersistenceException
Constructs a new PersistenceException exception with null as its detail message. true
true
PERSISTENCE:JAVADOC:157PersistenceExceptionjakarta.persistence.PersistenceException.PersistenceException
( String )
Constructs a new PersistenceException exception with the specified detail message. true
true
PERSISTENCE:JAVADOC:158PersistenceExceptionjakarta.persistence.PersistenceException.PersistenceException
( String ,
Throwable )
Constructs a new PersistenceException exception with the specified detail message and cause. true
true
PERSISTENCE:JAVADOC:159PersistenceExceptionjakarta.persistence.PersistenceException.PersistenceException
( Throwable )
Constructs a new PersistenceException exception with the specified cause. true
true
PERSISTENCE:JAVADOC:160Stringjakarta.persistence.PersistenceProperty.name
The name of the property true
false
PERSISTENCE:JAVADOC:161Stringjakarta.persistence.PersistenceProperty.value
The value of the property true
false
PERSISTENCE:JAVADOC:162Stringjakarta.persistence.PersistenceUnit.name
The name by which the entity manager factory is to be accessed in the environment referencing context, and is not needed when dependency injection is used. true
true
PERSISTENCE:JAVADOC:163Stringjakarta.persistence.PersistenceUnit.unitName
The name of the persistence unit as defined in the persistence.xml file. If specified, the persistence unit for the entity manager factory that is accessible in JNDI must have the same name. true
true
PERSISTENCE:JAVADOC:164PersistenceUnit[]jakarta.persistence.PersistenceUnits.value
One or more PersistenceUnit annotations. true
true
PERSISTENCE:JAVADOC:165Stringjakarta.persistence.PrimaryKeyJoinColumn.columnDefinition
(Optional) The SQL fragment that is used when generating the DDL for the column. This should not be specified for a OneToOne primary key association. Defaults to the generated SQL to create a column of the inferred type. false
true
PERSISTENCE:JAVADOC:166Stringjakarta.persistence.PrimaryKeyJoinColumn.name
The name of the primary key column of the current table. Defaults to the same name as the primary key column of the primary table of the superclass (InheritanceType#JOINED JOINED mapping strategy); the same name as the primary key column of the primary table (SecondaryTable mapping); or the same name as the primary key column for the table for the referencing entity (OneToOne mapping) true
true
PERSISTENCE:JAVADOC:167Stringjakarta.persistence.PrimaryKeyJoinColumn.referencedColumnName
(Optional) The name of the primary key column of the table being joined to. Defaults to the same name as the primary key column of the primary table of the superclass (InheritanceType#JOINED JOINED mapping strategy); the same name as the primary key column of the primary table (SecondaryTable mapping); or the same name as the primary key column for the table for the referencing entity (OneToOne mapping) true
true
PERSISTENCE:JAVADOC:168PrimaryKeyJoinColumn[]jakarta.persistence.PrimaryKeyJoinColumns.value
One or more PrimaryKeyJoinColumn annotations. true
true
PERSISTENCE:JAVADOC:169intjakarta.persistence.Query.executeUpdate
Execute an update or delete statement. true
true
PERSISTENCE:JAVADOC:170Listjakarta.persistence.Query.getResultList
Execute a SELECT query and return the query results as a List. true
true
PERSISTENCE:JAVADOC:171Objectjakarta.persistence.Query.getSingleResult
Execute a SELECT query that returns a single result. true
true
PERSISTENCE:JAVADOC:172Queryjakarta.persistence.Query.setFirstResult
( int )
Set the position of the first result to retrieve. true
true
PERSISTENCE:JAVADOC:173Queryjakarta.persistence.Query.setFlushMode
( FlushModeType )
Set the flush mode type to be used for the query execution. The flush mode type applies to the query regardless of the flush mode type in use for the entity manager. true
true
PERSISTENCE:JAVADOC:174Queryjakarta.persistence.Query.setHint
( String ,
Object )
Set an implementation-specific hint. If the hint name is not recognized, it is silently ignored. true
false
PERSISTENCE:JAVADOC:175Queryjakarta.persistence.Query.setMaxResults
( int )
Set the maximum number of results to retrieve. true
true
PERSISTENCE:JAVADOC:176Queryjakarta.persistence.Query.setParameter
( String ,
Object )
Bind an argument to a named parameter. true
true
PERSISTENCE:JAVADOC:177Queryjakarta.persistence.Query.setParameter
( String ,
Date ,
TemporalType )
Bind an instance of java.util.Date to a named parameter. true
true
PERSISTENCE:JAVADOC:178Queryjakarta.persistence.Query.setParameter
( String ,
Calendar ,
TemporalType )
Bind an instance of java.util.Calendar to a named parameter. true
true
PERSISTENCE:JAVADOC:179Queryjakarta.persistence.Query.setParameter
( int ,
Object )
Bind an argument to a positional parameter. true
true
PERSISTENCE:JAVADOC:180Queryjakarta.persistence.Query.setParameter
( int ,
Date ,
TemporalType )
Bind an instance of java.util.Date to a positional parameter. true
true
PERSISTENCE:JAVADOC:181Queryjakarta.persistence.Query.setParameter
( int ,
Calendar ,
TemporalType )
Bind an instance of java.util.Calendar to a positional parameter. true
true
PERSISTENCE:JAVADOC:182Stringjakarta.persistence.QueryHint.name
Name of the hint true
false
PERSISTENCE:JAVADOC:183Stringjakarta.persistence.QueryHint.value
Value of the hint true
false
PERSISTENCE:JAVADOC:184RollbackExceptionjakarta.persistence.RollbackException.RollbackException
Constructs a new RollbackException exception with null as its detail message. true
true
PERSISTENCE:JAVADOC:185RollbackExceptionjakarta.persistence.RollbackException.RollbackException
( String )
Constructs a new RollbackException exception with the specified detail message. true
true
PERSISTENCE:JAVADOC:186RollbackExceptionjakarta.persistence.RollbackException.RollbackException
( String ,
Throwable )
Constructs a new RollbackException exception with the specified detail message and cause. true
true
PERSISTENCE:JAVADOC:187RollbackExceptionjakarta.persistence.RollbackException.RollbackException
( Throwable )
Constructs a new RollbackException exception with the specified cause. true
true
PERSISTENCE:JAVADOC:188Stringjakarta.persistence.SecondaryTable.catalog
(Optional) The catalog of the table. Defaults to the default catalog. true
true
PERSISTENCE:JAVADOC:189Stringjakarta.persistence.SecondaryTable.name
(Required) The name of the table. true
true
PERSISTENCE:JAVADOC:190PrimaryKeyJoinColumn[]jakarta.persistence.SecondaryTable.pkJoinColumns
(Optional) The columns that are used to join with the primary table. Defaults to the column(s) of the same name(s) as the primary key column(s) in the primary table true
true
PERSISTENCE:JAVADOC:191Stringjakarta.persistence.SecondaryTable.schema
(Optional) The schema of the table. Defaults to the default schema for user. true
true
PERSISTENCE:JAVADOC:192UniqueConstraint[]jakarta.persistence.SecondaryTable.uniqueConstraints
(Optional) Unique constraints that are to be placed on the table. These are typically only used if table generation is in effect. These constraints apply in addition to any constraints specified by the Column and JoinColumn annotations and constraints entailed by primary key mappings. Defaults to no additional constraints. true
true
PERSISTENCE:JAVADOC:193SecondaryTable[]jakarta.persistence.SecondaryTables.value
The secondary tables for an entity. true
true
PERSISTENCE:JAVADOC:194intjakarta.persistence.SequenceGenerator.allocationSize
(Optional) The amount to increment by when allocating sequence numbers from the sequence. true
true
PERSISTENCE:JAVADOC:195intjakarta.persistence.SequenceGenerator.initialValue
(Optional) The value from which the sequence object is to start generating. true
true
PERSISTENCE:JAVADOC:196Stringjakarta.persistence.SequenceGenerator.name
(Required) A unique generator name that can be referenced by one or more classes to be the generator for primary key values. true
true
PERSISTENCE:JAVADOC:197Stringjakarta.persistence.SequenceGenerator.sequenceName
(Optional) The name of the database sequence object from which to obtain primary key values. Defaults to a provider-chosen value. true
true
PERSISTENCE:JAVADOC:198ColumnResult[]jakarta.persistence.SqlResultSetMapping.columns
Specifies the result set mapping to scalar values. true
true
PERSISTENCE:JAVADOC:199EntityResult[]jakarta.persistence.SqlResultSetMapping.entities
Specifies the result set mapping to entities. true
true
PERSISTENCE:JAVADOC:200Stringjakarta.persistence.SqlResultSetMapping.name
The name given to the result set mapping, and used to refer to it in the methods of the Query API. true
true
PERSISTENCE:JAVADOC:201SqlResultSetMapping[]jakarta.persistence.SqlResultSetMappings.value
One or more SqlResultSetMapping. true
true
PERSISTENCE:JAVADOC:202Stringjakarta.persistence.Table.catalog
(Optional) The catalog of the table. Defaults to the default catalog. true
true
PERSISTENCE:JAVADOC:203Stringjakarta.persistence.Table.name
(Optional) The name of the table. Defaults to the entity name. true
true
PERSISTENCE:JAVADOC:204Stringjakarta.persistence.Table.schema
(Optional) The schema of the table. Defaults to the default schema for user. true
true
PERSISTENCE:JAVADOC:205UniqueConstraint[]jakarta.persistence.Table.uniqueConstraints
(Optional) Unique constraints that are to be placed on the table. These are only used if table generation is in effect. These constraints apply in addition to any constraints specified by the Column and JoinColumn annotations and constraints entailed by primary key mappings. Defaults to no additional constraints. false
true
PERSISTENCE:JAVADOC:206intjakarta.persistence.TableGenerator.allocationSize
(Optional) The amount to increment by when allocating id numbers from the generator. true
true
PERSISTENCE:JAVADOC:207Stringjakarta.persistence.TableGenerator.catalog
(Optional) The catalog of the table. Defaults to the default catalog. true
true
PERSISTENCE:JAVADOC:208intjakarta.persistence.TableGenerator.initialValue
(Optional) The initial value to be used when allocating id numbers from the generator. true
true
PERSISTENCE:JAVADOC:209Stringjakarta.persistence.TableGenerator.name
(Required) A unique generator name that can be referenced by one or more classes to be the generator for id values. true
true
PERSISTENCE:JAVADOC:210Stringjakarta.persistence.TableGenerator.pkColumnName
(Optional) Name of the primary key column in the table. Defaults to a provider-chosen name. true
true
PERSISTENCE:JAVADOC:211Stringjakarta.persistence.TableGenerator.pkColumnValue
(Optional) The primary key value in the generator table that distinguishes this set of generated values from others that may be stored in the table. Defaults to a provider-chosen value to store in the primary key column of the generator table true
true
PERSISTENCE:JAVADOC:212Stringjakarta.persistence.TableGenerator.schema
(Optional) The schema of the table. Defaults to the default schema for user. true
true
PERSISTENCE:JAVADOC:213Stringjakarta.persistence.TableGenerator.table
(Optional) Name of table that stores the generated id values. Defaults to a name chosen by persistence provider. true
true
PERSISTENCE:JAVADOC:214UniqueConstraint[]jakarta.persistence.TableGenerator.uniqueConstraints
(Optional) Unique constraints that are to be placed on the table. These are only used if table generation is in effect. These constraints apply in addition to primary key constraints. Defaults to no additional constraints. false
true
PERSISTENCE:JAVADOC:215Stringjakarta.persistence.TableGenerator.valueColumnName
(Optional) Name of the column that stores the last value generated. Defaults to a provider-chosen name. true
true
PERSISTENCE:JAVADOC:216TemporalTypejakarta.persistence.Temporal.value
The type used in mapping java.util.Date or java.util.Calendar. true
true
PERSISTENCE:JAVADOC:217TemporalTypejakarta.persistence.TemporalType.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:218TemporalType[]jakarta.persistence.TemporalType.values

true
true
PERSISTENCE:JAVADOC:219TransactionRequiredExceptionjakarta.persistence.TransactionRequiredException.TransactionRequiredException
Constructs a new TransactionRequiredException exception with null as its detail message. true
true
PERSISTENCE:JAVADOC:220TransactionRequiredExceptionjakarta.persistence.TransactionRequiredException.TransactionRequiredException
( String )
Constructs a new TransactionRequiredException exception with the specified detail message. true
true
PERSISTENCE:JAVADOC:221String[]jakarta.persistence.UniqueConstraint.columnNames
(Required) An array of the column names that make up the constraint. true
false
PERSISTENCE:JAVADOC:222byte[]jakarta.persistence.spi.ClassTransformer.transform
( ClassLoader ,
String ,
Class ,
ProtectionDomain ,
byte[] )
Invoked when a class is being loaded or redefined. The implementation of this method may transform the supplied class file and return a new replacement class file. true
true
PERSISTENCE:JAVADOC:223byte[]jakarta.persistence.spi.ClassTransformer.transform
( ClassLoader ,
String ,
Class ,
ProtectionDomain ,
byte[] )
throws IllegalClassFormatException
If the input does not represent a well-formed class filetrue
true
PERSISTENCE:JAVADOC:224EntityManagerFactoryjakarta.persistence.spi.PersistenceProvider.createContainerEntityManagerFactory
( PersistenceUnitInfo ,
Map )
Called by the container when an jakarta.persistence.EntityManagerFactory is to be created. true
true
PERSISTENCE:JAVADOC:225EntityManagerFactoryjakarta.persistence.spi.PersistenceProvider.createEntityManagerFactory
( String ,
Map )
Called by Persistence class when an jakarta.persistence.EntityManagerFactory is to be created. true
true
PERSISTENCE:JAVADOC:226voidjakarta.persistence.spi.PersistenceUnitInfo.addTransformer
( ClassTransformer )
Add a transformer supplied by the provider that will be called for every new class definition or class redefinition that gets loaded by the loader returned by the PersistenceUnitInfo#getClassLoader method. The transformer has no effect on the result returned by the PersistenceUnitInfo#getNewTempClassLoader method. Classes are only transformed once within the same classloading scope, regardless of how many persistence units they may be a part of. true
true
PERSISTENCE:JAVADOC:227booleanjakarta.persistence.spi.PersistenceUnitInfo.excludeUnlistedClasses
Returns whether classes in the root of the persistence unit that have not been explicitly listed are to be included in the set of managed classes. This value corresponds to the element in the persistence.xml file. true
true
PERSISTENCE:JAVADOC:228ClassLoaderjakarta.persistence.spi.PersistenceUnitInfo.getClassLoader
Returns ClassLoader that the provider may use to load any classes, resources, or open URLs. true
true
PERSISTENCE:JAVADOC:229Listjakarta.persistence.spi.PersistenceUnitInfo.getJarFileUrls
Returns a list of URLs for the jar files or exploded jar file directories that the persistence provider must examine for managed classes of the persistence unit. Each URL corresponds to a named element in the persistence.xml file. A URL will either be a file: URL referring to a jar file or referring to a directory that contains an exploded jar file, or some other URL from which an InputStream in jar format can be obtained. true
true
PERSISTENCE:JAVADOC:230DataSourcejakarta.persistence.spi.PersistenceUnitInfo.getJtaDataSource
Returns the JTA-enabled data source to be used by the persistence provider. The data source corresponds to the element in the persistence.xml file or is provided at deployment or by the container. true
true
PERSISTENCE:JAVADOC:231Listjakarta.persistence.spi.PersistenceUnitInfo.getManagedClassNames
Returns the list of the names of the classes that the persistence provider must add it to its set of managed classes. Each name corresponds to a named element in the persistence.xml file. true
true
PERSISTENCE:JAVADOC:232Listjakarta.persistence.spi.PersistenceUnitInfo.getMappingFileNames
Returns the list of mapping file names that the persistence provider must load to determine the mappings for the entity classes. The mapping files must be in the standard XML mapping format, be uniquely named and be resource-loadable from the application classpath. This list will not include the orm.xml file if one was specified. Each mapping file name corresponds to a element in the persistence.xml file. true
true
PERSISTENCE:JAVADOC:233ClassLoaderjakarta.persistence.spi.PersistenceUnitInfo.getNewTempClassLoader
Return a new instance of a ClassLoader that the provider may use to temporarily load any classes, resources, or open URLs. The scope and classpath of this loader is exactly the same as that of the loader returned by PersistenceUnitInfo#getClassLoader. None of the classes loaded by this class loader will be visible to application components. The provider may only use this ClassLoader within the scope of the PersistenceProvider#createContainerEntityManagerFactory call. true
true
PERSISTENCE:JAVADOC:234DataSourcejakarta.persistence.spi.PersistenceUnitInfo.getNonJtaDataSource
Returns the non-JTA-enabled data source to be used by the persistence provider for accessing data outside a JTA transaction. The data source corresponds to the named element in the persistence.xml file or provided at deployment or by the container. true
true
PERSISTENCE:JAVADOC:235Stringjakarta.persistence.spi.PersistenceUnitInfo.getPersistenceProviderClassName
Returns the fully qualified name of the persistence provider implementation class. Corresponds to the element in the persistence.xml file. true
true
PERSISTENCE:JAVADOC:236Stringjakarta.persistence.spi.PersistenceUnitInfo.getPersistenceUnitName
Returns the name of the persistence unit. Corresponds to the name attribute in the persistence.xml file. true
true
PERSISTENCE:JAVADOC:237URLjakarta.persistence.spi.PersistenceUnitInfo.getPersistenceUnitRootUrl
Returns the URL for the jar file or directory that is the root of the persistence unit. (If the persistence unit is rooted in the WEB-INF/classes directory, this will be the URL of that directory.) The URL will either be a file: URL referring to a jar file or referring to a directory that contains an exploded jar file, or some other URL from which an InputStream in jar format can be obtained. true
true
PERSISTENCE:JAVADOC:238Propertiesjakarta.persistence.spi.PersistenceUnitInfo.getProperties
Returns properties object. Each property corresponds to a element in the persistence.xml file true
true
PERSISTENCE:JAVADOC:239PersistenceUnitTransactionTypejakarta.persistence.spi.PersistenceUnitInfo.getTransactionType
Returns the transaction type of the entity managers created by the EntityManagerFactory. The transaction type corresponds to the transaction-type attribute in the persistence.xml file. true
true
PERSISTENCE:JAVADOC:240PersistenceUnitTransactionTypejakarta.persistence.spi.PersistenceUnitTransactionType.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:241PersistenceUnitTransactionType[]jakarta.persistence.spi.PersistenceUnitTransactionType.values

true
true