Jakarta Persistence - 2.2
JavaDoc Assertion Detail

TotalsTotalActiveDeprecatedRemoved
# of Assertions 17909280862
# of Required Assertions 17739170856
# of Optional Assertions 171106

IDReturnMethod/FieldDescriptionRequiredDeprecatedTestable
PERSISTENCE:JAVADOC:1JoinColumn[]jakarta.persistence.AssociationOverride.joinColumns
The join column(s) being mapped to the persistent attribute(s). The joinColumns elements must be specified if a foreign key mapping is used in the overriding of the mapping of the relationship. The joinColumns element must not be specified if a join table is used in the overriding of the mapping of the relationship.true
true
PERSISTENCE:JAVADOC:2Stringjakarta.persistence.AssociationOverride.name
(Required) 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
(Required) The association override mappings that are to be applied to the relationship field or property .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
(Required) One or more field or property mapping overrides.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.true
true
PERSISTENCE:JAVADOC:13intjakarta.persistence.Column.length
(Optional) The column length. (Applies only if a string-valued column is used.)true
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.true
true
PERSISTENCE:JAVADOC:17intjakarta.persistence.Column.scale
(Optional) The scale for a decimal (exact numeric) column. (Applies only if a decimal column is used.)true
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.true
true
PERSISTENCE:JAVADOC:19booleanjakarta.persistence.Column.unique
(Optional) Whether the column 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 corresponds to only a single column. This constraint applies in addition to any constraint entailed by primary key mapping and to constraints specified at the table level.true
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
(Required) The name of a column in the SELECT clause of a SQL querytrue
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 STRING, the discriminator value default is the entity name.true
true
PERSISTENCE:JAVADOC:29Stringjakarta.persistence.Entity.name
(Optional) The entity name. 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 classestrue
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 entity manager. After the close method has been invoked, all methods on the EntityManager instance and any Query, TypedQuery, and StoredProcedureQuery objects obtained from it will throw the IllegalStateException except for getProperties, getTransaction, and isOpen (which will return false). If this method is called when the entity manager is joined to 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 is a managed entity instance belonging 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. If the query is not an update or delete query, query execution will result in each row of the SQL result being returned as a result of type Object[] (or a result of type Object if there is only one column in the select list.) Column values are returned in the order of their appearance in the select list and default JDBC type mappings are applied.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. Search for an entity of the specified class and primary key. If the entity instance is contained in the persistence context, it is returned from there.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. The unwrap method is to be preferred for new applications.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, the EntityNotFoundException is thrown when the instance state is first accessed. (The persistence provider runtime is permitted to throw the 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
Return the resource-level EntityTransaction 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 entity manager is open.true
true
PERSISTENCE:JAVADOC:50voidjakarta.persistence.EntityManager.joinTransaction
Indicate to the entity manager that a JTA transaction is active and join the persistence context to it. This method should be called on a JTA application managed entity manager that was created outside the scope of the active transaction or on an entity manager of type SynchronizationType.UNSYNCHRONIZED to associate it with the current JTA transaction.true
true
PERSISTENCE:JAVADOC:51voidjakarta.persistence.EntityManager.lock
( Object ,
LockModeType )
Lock an entity instance that is contained in the persistence context with the specified lock mode type. If a pessimistic lock mode type is specified and the entity contains a version attribute, the persistence provider must also perform optimistic version checks when obtaining the database lock. If these checks fail, the OptimisticLockException will be thrown. If the lock mode type is pessimistic and the entity instance is found but cannot be locked: the PessimisticLockException will be thrown if the database locking failure causes transaction-level rollback the LockTimeoutException will be thrown if the database locking failure causes only statement-level rollbacktrue
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 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 has been closed, all methods invoked on it will throw the 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 application-managed 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 application-managed 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 the factory is open. Returns true until the factory has been closed.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 a resource transaction.true
true
PERSISTENCE:JAVADOC:67voidjakarta.persistence.EntityTransaction.commit
Commit the current resource transaction, writing any unflushed changes to the database.true
true
PERSISTENCE:JAVADOC:68booleanjakarta.persistence.EntityTransaction.getRollbackOnly
Determine whether the current resource transaction has been marked for rollback.true
true
PERSISTENCE:JAVADOC:69booleanjakarta.persistence.EntityTransaction.isActive
Indicate whether a resource transaction is in progress.true
true
PERSISTENCE:JAVADOC:70voidjakarta.persistence.EntityTransaction.rollback
Roll back the current resource transaction.true
true
PERSISTENCE:JAVADOC:71voidjakarta.persistence.EntityTransaction.setRollbackOnly
Mark the current resource 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 classtrue
true
PERSISTENCE:JAVADOC:86InheritanceTypejakarta.persistence.Inheritance.strategy
The strategy to be used for the entity inheritance hierarchy.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 ManyToOne mapping using a foreign key mapping strategy, the foreign key column is in the table of the source entity or embeddable. If the join is for a unidirectional OneToMany mapping using a foreign key mapping strategy, the foreign key is in the table of the target entity. If the join is for a ManyToMany mapping or for a OneToOne or bidirectional ManyToOne/OneToMany mapping using a join table, the foreign key is in a join table. If the join is for an element collection, the foreign key is in a collection 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 or embeddable class; "_"; the name of the referenced primary key column. If there is no such referencing relationship property or field in the entity, or if the join is for an element collection, 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 entity relationship mappings other than the cases described here, the referenced column is in the table of the target entity. When used with a unidirectional OneToMany foreign key mapping, the referenced column is in the table of the source 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. When used in a CollectionTable mapping, the referenced column is in the table of the entity containing the collection. 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. Default: If the join is for a OneToOne or ManyToOne mapping using a foreign key mapping strategy, the name of the table of the source entity or embeddable. If the join is for a unidirectional OneToMany mapping using a foreign key mapping strategy, the name of the table of the target entity. If the join is for a ManyToMany mapping or for a OneToOne or bidirectional ManyToOne/OneToMany mapping using a join table, the name of the join table. If the join is for an element collection, the name of the collection table.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
The join columns that map the relationship.true
true
PERSISTENCE:JAVADOC:98Stringjakarta.persistence.JoinTable.catalog
(Optional) The catalog of the table. Defaults to the default catalog.true
false
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. When the target collection is a java.util.Map java.util.Map, the cascade element applies to the map value. 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 EAGER strategy is a requirement on the persistence provider runtime that the associated entities must be eagerly fetched. The 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-valued relationship 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 EAGER strategy is a requirement on the persistence provider runtime that the associated entity must be eagerly fetched. The 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
(Optional) The name of the persistent field or property of the associated entity that is used as the map key. Default: 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
(Required) Array of NamedNativeQuery annotations.true
true
PERSISTENCE:JAVADOC:116QueryHint[]jakarta.persistence.NamedNativeQuery.hints
Query properties and hints. (May include vendor-specific query hints.)true
false
PERSISTENCE:JAVADOC:117Stringjakarta.persistence.NamedNativeQuery.name
The name used to refer to the query with 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
(Required) An array of NamedQuery annotations.true
true
PERSISTENCE:JAVADOC:122QueryHint[]jakarta.persistence.NamedQuery.hints
(Optional) Query properties and hints. May include vendor-specific query hints.true
false
PERSISTENCE:JAVADOC:123Stringjakarta.persistence.NamedQuery.name
(Required) The name used to refer to the query with the EntityManager methods that create query objects.true
true
PERSISTENCE:JAVADOC:124Stringjakarta.persistence.NamedQuery.query
(Required) 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. When the target collection is a java.util.Map java.util.Map, the cascade element applies to the map value.true
true
PERSISTENCE:JAVADOC:130FetchTypejakarta.persistence.OneToMany.fetch
(Optional) Whether the association should be lazily loaded or must be eagerly fetched. The EAGER strategy is a requirement on the persistence provider runtime that the associated entities must be eagerly fetched. The 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 EAGER strategy is a requirement on the persistence provider runtime that the associated entity must be eagerly fetched. The 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
true
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
(Optional) The name by which the entity manager is to be accessed in the environment referencing context; not needed when dependency injection is used.true
true
PERSISTENCE:JAVADOC:150PersistenceProperty[]jakarta.persistence.PersistenceContext.properties
(Optional) 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
(Optional) Specifies whether a transaction-scoped persistence context or an extended persistence context is to be used.true
true
PERSISTENCE:JAVADOC:152Stringjakarta.persistence.PersistenceContext.unitName
(Optional) The name of the persistence unit as defined in the persistence.xml file. 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
(Required) One or more PersistenceContext annotations.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 propertytrue
false
PERSISTENCE:JAVADOC:161Stringjakarta.persistence.PersistenceProperty.value
The value of the propertytrue
false
PERSISTENCE:JAVADOC:162Stringjakarta.persistence.PersistenceUnit.name
(Optional) The name by which the entity manager factory is to be accessed in the environment referencing context; not needed when dependency injection is used.true
true
PERSISTENCE:JAVADOC:163Stringjakarta.persistence.PersistenceUnit.unitName
(Optional) 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
(Required) 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
(Optional) 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 (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 (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
false
PERSISTENCE:JAVADOC:170Listjakarta.persistence.Query.getResultList
Execute a SELECT query and return the query results as an untyped List.true
true
PERSISTENCE:JAVADOC:171Objectjakarta.persistence.Query.getSingleResult
Execute a SELECT query that returns a single untyped 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 a query property or hint. The hints elements may be used to specify query properties and hints. Properties defined by this specification must be observed by the provider. Vendor-specific hints that are not recognized by a provider must be silently ignored. Portable applications should not rely on the standard timeout hint. Depending on the database in use and the locking mechanisms used by the provider, this hint may or may not be observed.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 value 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 value 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
false
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
false
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
(Required) 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 and StoredProcedureQuery APIs.true
true
PERSISTENCE:JAVADOC:201SqlResultSetMapping[]jakarta.persistence.SqlResultSetMappings.value
One or more SqlResultSetMapping annotations.true
true
PERSISTENCE:JAVADOC:202Stringjakarta.persistence.Table.catalog
(Optional) The catalog of the table. Defaults to the default catalog.true
false
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
false
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
false
PERSISTENCE:JAVADOC:208intjakarta.persistence.TableGenerator.initialValue
(Optional) The initial value to be used to initialize the column that stores the last value generated.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 tabletrue
true
PERSISTENCE:JAVADOC:212Stringjakarta.persistence.TableGenerator.schema
(Optional) The schema of the table. Defaults to the default schema for user.true
false
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:300AccessTypejakarta.persistence.Access.value
(Required) Specification of field- or property-based access.true
true
PERSISTENCE:JAVADOC:301AccessTypejakarta.persistence.AccessType.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:302AccessType[]jakarta.persistence.AccessType.values

true
true
PERSISTENCE:JAVADOC:303JoinTablejakarta.persistence.AssociationOverride.joinTable
The join table that maps the relationship. The joinTable element must be specified if a join table is used in the overriding of the mapping of the relationship. The joinTable element must not be specified if a foreign key mapping is used in the overriding of the relationship.true
true
PERSISTENCE:JAVADOC:304booleanjakarta.persistence.Cache.contains
( Class ,
Object )
Whether the cache contains data for the given entity.true
true
PERSISTENCE:JAVADOC:305voidjakarta.persistence.Cache.evict
( Class ,
Object )
Remove the data for the given entity from the cache.true
true
PERSISTENCE:JAVADOC:306voidjakarta.persistence.Cache.evict
( Class )
Remove the data for entities of the specified class (and its subclasses) from the cache.true
true
PERSISTENCE:JAVADOC:307voidjakarta.persistence.Cache.evictAll
Clear the cache.true
true
PERSISTENCE:JAVADOC:308booleanjakarta.persistence.Cacheable.value
(Optional) Whether or not the entity should be cached.true
true
PERSISTENCE:JAVADOC:309CacheRetrieveModejakarta.persistence.CacheRetrieveMode.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:310CacheRetrieveMode[]jakarta.persistence.CacheRetrieveMode.values

true
true
PERSISTENCE:JAVADOC:311CacheStoreModejakarta.persistence.CacheStoreMode.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:312CacheStoreMode[]jakarta.persistence.CacheStoreMode.values

true
true
PERSISTENCE:JAVADOC:313Stringjakarta.persistence.CollectionTable.catalog
(Optional) The catalog of the table. If not specified, the default catalog is used.true
false
PERSISTENCE:JAVADOC:314JoinColumn[]jakarta.persistence.CollectionTable.joinColumns
(Optional) The foreign key columns of the collection table which reference the primary table of the entity. The default only applies if a single join column is used. The default is the same as for JoinColumn (i.e., the concatenation of the following: the name of the entity; "_"; the name of the referenced primary key column.) However, if there is more than one join column, a JoinColumn annotation must be specified for each join column using the JoinColumns annotation. In this case, both the name and the referencedColumnName elements must be specified in each such JoinColumn annotation.true
true
PERSISTENCE:JAVADOC:315Stringjakarta.persistence.CollectionTable.name
(Optional) The name of the collection table. If not specified, it defaults to the concatenation of the name of the containing entity and the name of the collection attribute, separated by an underscore.true
true
PERSISTENCE:JAVADOC:316Stringjakarta.persistence.CollectionTable.schema
(Optional) The schema of the table. If not specified, the default schema for the user is used.true
false
PERSISTENCE:JAVADOC:317UniqueConstraint[]jakarta.persistence.CollectionTable.uniqueConstraints
(Optional) Unique constraints that are to be placed on the table. These are only used if table generation is in effect.true
true
PERSISTENCE:JAVADOC:318FetchTypejakarta.persistence.ElementCollection.fetch
(Optional) Whether the collection should be lazily loaded or must be eagerly fetched. The EAGER strategy is a requirement on the persistence provider runtime that the collection elements must be eagerly fetched. The LAZY strategy is a hint to the persistence provider runtime.true
true
PERSISTENCE:JAVADOC:319Classjakarta.persistence.ElementCollection.targetClass
(Optional) The basic or embeddable class that is the element type of the collection. This element is optional only if the collection field or property is defined using Java generics, and must be specified otherwise. It defaults to the paramterized type of the collection when defined using generics.true
true
PERSISTENCE:JAVADOC:320TypedQueryjakarta.persistence.EntityManager.createNamedQuery
( String ,
Class )
Create an instance of TypedQuery for executing a Java Persistence query language named query. The select list of the query must contain only a single item, which must be assignable to the type specified by the resultClass argument.true
true
PERSISTENCE:JAVADOC:321TypedQueryjakarta.persistence.EntityManager.createQuery
( CriteriaQuery )
Create an instance of TypedQuery for executing a criteria query.true
true
PERSISTENCE:JAVADOC:322TypedQueryjakarta.persistence.EntityManager.createQuery
( String ,
Class )
Create an instance of TypedQuery for executing a Java Persistence query language statement. The select list of the query must contain only a single item, which must be assignable to the type specified by the resultClass argument.true
true
PERSISTENCE:JAVADOC:323voidjakarta.persistence.EntityManager.detach
( Object )
Remove the given entity from the persistence context, causing a managed entity to become detached. Unflushed changes made to the entity if any (including removal of the entity), will not be synchronized to the database. Entities which previously referenced the detached entity will continue to reference it.true
true
PERSISTENCE:JAVADOC:324Objectjakarta.persistence.EntityManager.find
( Class ,
Object ,
Map )
Find by primary key, using the specified properties. Search for an entity of the specified class and primary key. If the entity instance is contained in the persistence context, it is returned from there. If a vendor-specific property or hint is not recognized, it is silently ignored.true
true
PERSISTENCE:JAVADOC:325Objectjakarta.persistence.EntityManager.find
( Class ,
Object ,
LockModeType )
Find by primary key and lock. Search for an entity of the specified class and primary key and lock it with respect to the specified lock type. If the entity instance is contained in the persistence context, it is returned from there, and the effect of this method is the same as if the lock method had been called on the entity. If the entity is found within the persistence context and the lock mode type is pessimistic and the entity has a version attribute, the persistence provider must perform optimistic version checks when obtaining the database lock. If these checks fail, the OptimisticLockException will be thrown. If the lock mode type is pessimistic and the entity instance is found but cannot be locked: the PessimisticLockException will be thrown if the database locking failure causes transaction-level rollback the LockTimeoutException will be thrown if the database locking failure causes only statement-level rollbacktrue
true
PERSISTENCE:JAVADOC:326Objectjakarta.persistence.EntityManager.find
( Class ,
Object ,
LockModeType ,
Map )
Find by primary key and lock, using the specified properties. Search for an entity of the specified class and primary key and lock it with respect to the specified lock type. If the entity instance is contained in the persistence context, it is returned from there. If the entity is found within the persistence context and the lock mode type is pessimistic and the entity has a version attribute, the persistence provider must perform optimistic version checks when obtaining the database lock. If these checks fail, the OptimisticLockException will be thrown. If the lock mode type is pessimistic and the entity instance is found but cannot be locked: the PessimisticLockException will be thrown if the database locking failure causes transaction-level rollback the LockTimeoutException will be thrown if the database locking failure causes only statement-level rollback If a vendor-specific property or hint is not recognized, it is silently ignored. Portable applications should not rely on the standard timeout hint. Depending on the database in use and the locking mechanisms used by the provider, the hint may or may not be observed.true
true
PERSISTENCE:JAVADOC:327CriteriaBuilderjakarta.persistence.EntityManager.getCriteriaBuilder
Return an instance of CriteriaBuilder for the creation of CriteriaQuery objects.true
true
PERSISTENCE:JAVADOC:328EntityManagerFactoryjakarta.persistence.EntityManager.getEntityManagerFactory
Return the entity manager factory for the entity manager.true
true
PERSISTENCE:JAVADOC:329LockModeTypejakarta.persistence.EntityManager.getLockMode
( Object )
Get the current lock mode for the entity instance.true
true
PERSISTENCE:JAVADOC:330Metamodeljakarta.persistence.EntityManager.getMetamodel
Return an instance of Metamodel interface for access to the metamodel of the persistence unit.true
true
PERSISTENCE:JAVADOC:331Mapjakarta.persistence.EntityManager.getProperties
Get the properties and hints and associated values that are in effect for the entity manager. Changing the contents of the map does not change the configuration in effect.true
true
PERSISTENCE:JAVADOC:332voidjakarta.persistence.EntityManager.lock
( Object ,
LockModeType ,
Map )
Lock an entity instance that is contained in the persistence context with the specified lock mode type and with specified properties. If a pessimistic lock mode type is specified and the entity contains a version attribute, the persistence provider must also perform optimistic version checks when obtaining the database lock. If these checks fail, the OptimisticLockException will be thrown. If the lock mode type is pessimistic and the entity instance is found but cannot be locked: the PessimisticLockException will be thrown if the database locking failure causes transaction-level rollback the LockTimeoutException will be thrown if the database locking failure causes only statement-level rollback If a vendor-specific property or hint is not recognized, it is silently ignored. Portable applications should not rely on the standard timeout hint. Depending on the database in use and the locking mechanisms used by the provider, the hint may or may not be observed.true
true
PERSISTENCE:JAVADOC:333voidjakarta.persistence.EntityManager.refresh
( Object ,
Map )
Refresh the state of the instance from the database, using the specified properties, and overwriting changes made to the entity, if any. If a vendor-specific property or hint is not recognized, it is silently ignored.true
true
PERSISTENCE:JAVADOC:334voidjakarta.persistence.EntityManager.refresh
( Object ,
LockModeType )
Refresh the state of the instance from the database, overwriting changes made to the entity, if any, and lock it with respect to given lock mode type. If the lock mode type is pessimistic and the entity instance is found but cannot be locked: the PessimisticLockException will be thrown if the database locking failure causes transaction-level rollback the LockTimeoutException will be thrown if the database locking failure causes only statement-level rollback.true
true
PERSISTENCE:JAVADOC:335voidjakarta.persistence.EntityManager.refresh
( Object ,
LockModeType ,
Map )
Refresh the state of the instance from the database, overwriting changes made to the entity, if any, and lock it with respect to given lock mode type and with specified properties. If the lock mode type is pessimistic and the entity instance is found but cannot be locked: the PessimisticLockException will be thrown if the database locking failure causes transaction-level rollback the LockTimeoutException will be thrown if the database locking failure causes only statement-level rollback If a vendor-specific property or hint is not recognized, it is silently ignored. Portable applications should not rely on the standard timeout hint. Depending on the database in use and the locking mechanisms used by the provider, the hint may or may not be observed.true
true
PERSISTENCE:JAVADOC:336voidjakarta.persistence.EntityManager.setProperty
( String ,
Object )
Set an entity manager property or hint. If a vendor-specific property or hint is not recognized, it is silently ignored.true
false
PERSISTENCE:JAVADOC:337Objectjakarta.persistence.EntityManager.unwrap
( Class )
Return an object of the specified type to allow access to the provider-specific API. If the provider's EntityManager implementation does not support the specified class, the PersistenceException is thrown.true
false
PERSISTENCE:JAVADOC:338Cachejakarta.persistence.EntityManagerFactory.getCache
Access the cache that is associated with the entity manager factory (the "second level cache").true
true
PERSISTENCE:JAVADOC:339CriteriaBuilderjakarta.persistence.EntityManagerFactory.getCriteriaBuilder
Return an instance of CriteriaBuilder for the creation of CriteriaQuery objects.true
true
PERSISTENCE:JAVADOC:340Metamodeljakarta.persistence.EntityManagerFactory.getMetamodel
Return an instance of Metamodel interface for access to the metamodel of the persistence unit.true
true
PERSISTENCE:JAVADOC:341PersistenceUnitUtiljakarta.persistence.EntityManagerFactory.getPersistenceUnitUtil
Return interface providing access to utility methods for the persistence unit.true
true
PERSISTENCE:JAVADOC:342Mapjakarta.persistence.EntityManagerFactory.getProperties
Get the properties and associated values that are in effect for the entity manager factory. Changing the contents of the map does not change the configuration in effect.true
false
PERSISTENCE:JAVADOC:343Objectjakarta.persistence.LockTimeoutException.getObject
Returns the object that caused this exception.true
true
PERSISTENCE:JAVADOC:344LockTimeoutExceptionjakarta.persistence.LockTimeoutException.LockTimeoutException
Constructs a new LockTimeoutException exception with null as its detail message.true
true
PERSISTENCE:JAVADOC:345LockTimeoutExceptionjakarta.persistence.LockTimeoutException.LockTimeoutException
( String )
Constructs a new LockTimeoutException exception with the specified detail message.true
true
PERSISTENCE:JAVADOC:346LockTimeoutExceptionjakarta.persistence.LockTimeoutException.LockTimeoutException
( String ,
Throwable )
Constructs a new LockTimeoutException exception with the specified detail message and cause.true
true
PERSISTENCE:JAVADOC:347LockTimeoutExceptionjakarta.persistence.LockTimeoutException.LockTimeoutException
( Throwable )
Constructs a new LockTimeoutException exception with the specified cause.true
true
PERSISTENCE:JAVADOC:348LockTimeoutExceptionjakarta.persistence.LockTimeoutException.LockTimeoutException
( Object )
Constructs a new LockTimeoutException exception with the specified object.true
true
PERSISTENCE:JAVADOC:349LockTimeoutExceptionjakarta.persistence.LockTimeoutException.LockTimeoutException
( String ,
Throwable ,
Object )
Constructs a new LockTimeoutException exception with the specified detail message, cause, and entity.true
true
PERSISTENCE:JAVADOC:350Classjakarta.persistence.MapKeyClass.value
(Required) The type of the map key.true
true
PERSISTENCE:JAVADOC:351Stringjakarta.persistence.MapKeyColumn.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.true
false
PERSISTENCE:JAVADOC:352booleanjakarta.persistence.MapKeyColumn.insertable
(Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider.true
true
PERSISTENCE:JAVADOC:353intjakarta.persistence.MapKeyColumn.length
(Optional) The column length. (Applies only if a string-valued column is used.)true
true
PERSISTENCE:JAVADOC:354Stringjakarta.persistence.MapKeyColumn.name
(Optional) The name of the map key column. The table in which it is found depends upon the context. If the map key is for an element collection, the map key column is in the collection table for the map value. If the map key is for a ManyToMany entity relationship or for a OneToMany entity relationship using a join table, the map key column is in a join table. If the map key is for a OneToMany entity relationship using a foreign key mapping strategy, the map key column is in the table of the entity that is the value of the map. Defaults to the concatenation of the following: the name of the referencing relationship field or property; "_"; "KEY".true
true
PERSISTENCE:JAVADOC:355booleanjakarta.persistence.MapKeyColumn.nullable
(Optional) Whether the database column is nullable.true
true
PERSISTENCE:JAVADOC:356intjakarta.persistence.MapKeyColumn.precision
(Optional) The precision for a decimal (exact numeric) column. (Applies only if a decimal column is used.) Default: 0. (The value must be set by the developer.)true
true
PERSISTENCE:JAVADOC:357intjakarta.persistence.MapKeyColumn.scale
(Optional) The scale for a decimal (exact numeric) column. (Applies only if a decimal column is used.)true
true
PERSISTENCE:JAVADOC:358Stringjakarta.persistence.MapKeyColumn.table
(Optional) The name of the table that contains the column. Defaults: If the map key is for an element collection, the name of the collection table for the map value. If the map key is for a OneToMany or ManyToMany entity relationship using a join table, the name of the join table for the map. If the map key is for a OneToMany entity relationship using a foreign key mapping strategy, the name of the primary table of the entity that is the value of the map.true
true
PERSISTENCE:JAVADOC:359booleanjakarta.persistence.MapKeyColumn.unique
(Optional) Whether the column 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 corresponds to only a single column. This constraint applies in addition to any constraint entailed by primary key mapping and to constraints specified at the table level.true
true
PERSISTENCE:JAVADOC:360booleanjakarta.persistence.MapKeyColumn.updatable
(Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider.true
true
PERSISTENCE:JAVADOC:361EnumTypejakarta.persistence.MapKeyEnumerated.value
(Optional) The type used in mapping a map key enum type.true
true
PERSISTENCE:JAVADOC:362Stringjakarta.persistence.MapKeyJoinColumn.columnDefinition
(Optional) The SQL fragment that is used when generating the DDL for the column. Defaults to SQL generated by the provider for the column.true
true
PERSISTENCE:JAVADOC:363booleanjakarta.persistence.MapKeyJoinColumn.insertable
(Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider.true
true
PERSISTENCE:JAVADOC:364Stringjakarta.persistence.MapKeyJoinColumn.name
(Optional) The name of the foreign key column for the map key. The table in which it is found depends upon the context. If the join is for a map key for an element collection, the foreign key column is in the collection table for the map value. If the join is for a map key for a ManyToMany entity relationship or for a OneToMany entity relationship using a join table, the foreign key column is in a join table. If the join is for a OneToMany entity relationship using a foreign key mapping strategy, the foreign key column for the map key is in the table of the entity that is the value of the map. 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 or embeddable class; "_"; "KEY".true
true
PERSISTENCE:JAVADOC:365booleanjakarta.persistence.MapKeyJoinColumn.nullable
(Optional) Whether the foreign key column is nullable.true
true
PERSISTENCE:JAVADOC:366Stringjakarta.persistence.MapKeyJoinColumn.referencedColumnName
(Optional) The name of the column referenced by this foreign key column. The referenced column is in the table of the target entity. Default (only applies if single join column is being used.) The same name as the primary key column of the referenced tabletrue
true
PERSISTENCE:JAVADOC:367Stringjakarta.persistence.MapKeyJoinColumn.table
(Optional) The name of the table that contains the foreign key column. If the join is for a map key for an element collection, the foreign key column is in the collection table for the map value. If the join is for a map key for a ManyToMany entity relationship or for a OneToMany entity relationship using a join table, the foreign key column is in a join table. If the join is for a OneToMany entity relationship using a foreign key mapping strategy, the foreign key column for the map key is in the table of the entity that is the value of the map. Default: If the map is for an element collection, the name of the collection table for the map value. If the map is for a OneToMany or ManyToMany entity relationship using a join table, the name of the join table for the map. If the map is for a OneToMany entity relationship using a foreign key mapping strategy, the name of the primary table of the entity that is the value of the map.true
true
PERSISTENCE:JAVADOC:368booleanjakarta.persistence.MapKeyJoinColumn.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.true
true
PERSISTENCE:JAVADOC:369booleanjakarta.persistence.MapKeyJoinColumn.updatable
(Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider.true
true
PERSISTENCE:JAVADOC:370MapKeyJoinColumn[]jakarta.persistence.MapKeyJoinColumns.value
(Required) The map key join columns that are used to map to the entity that is the map key.true
true
PERSISTENCE:JAVADOC:371TemporalTypejakarta.persistence.MapKeyTemporal.value
(Required) The type used in mapping java.util.Date or java.util.Calendar.true
true
PERSISTENCE:JAVADOC:372Stringjakarta.persistence.MapsId.value
(Optional) The name of the attribute within the composite key to which the relationship attribute corresponds. If not supplied, the relationship maps the entity's primary key.true
true
PERSISTENCE:JAVADOC:373LockModeTypejakarta.persistence.NamedQuery.lockMode
(Optional) The lock mode type to use in query execution. If a lockMode other than LockModeType.NONE is specified, the query must be executed in a transaction and the persistence context joined to the transaction.true
true
PERSISTENCE:JAVADOC:374booleanjakarta.persistence.OneToMany.orphanRemoval
(Optional) Whether to apply the remove operation to entities that have been removed from the relationship and to cascade the remove operation to those entities.true
true
PERSISTENCE:JAVADOC:375booleanjakarta.persistence.OneToOne.orphanRemoval
(Optional) Whether to apply the remove operation to entities that have been removed from the relationship and to cascade the remove operation to those entities.true
true
PERSISTENCE:JAVADOC:376Stringjakarta.persistence.OrderColumn.columnDefinition
(Optional) The SQL fragment that is used when generating the DDL for the column. Defaults to generated SQL to create a column of the inferred type.true
false
PERSISTENCE:JAVADOC:377booleanjakarta.persistence.OrderColumn.insertable
(Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider.true
true
PERSISTENCE:JAVADOC:378Stringjakarta.persistence.OrderColumn.name
(Optional) The name of the ordering column. Defaults to the concatenation of the name of the referencing property or field; "_"; "ORDER".true
true
PERSISTENCE:JAVADOC:379booleanjakarta.persistence.OrderColumn.nullable
(Optional) Whether the database column is nullable.true
true
PERSISTENCE:JAVADOC:380booleanjakarta.persistence.OrderColumn.updatable
(Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider.true
true
PERSISTENCE:JAVADOC:381Stringjakarta.persistence.Parameter.getName
Return the parameter name, or null if the parameter is not a named parameter or no name has been assigned.true
true
PERSISTENCE:JAVADOC:382Classjakarta.persistence.Parameter.getParameterType
Return the Java type of the parameter. Values bound to the parameter must be assignable to this type. This method is required to be supported for criteria queries only. Applications that use this method for Java Persistence query language queries and native queries will not be portable.true
true
PERSISTENCE:JAVADOC:383Integerjakarta.persistence.Parameter.getPosition
Return the parameter position, or null if the parameter is not a positional parameter.true
true
PERSISTENCE:JAVADOC:384PersistenceUtiljakarta.persistence.Persistence.getPersistenceUtil
Return the PersistenceUtil instancetrue
true
PERSISTENCE:JAVADOC:385Objectjakarta.persistence.PersistenceUnitUtil.getIdentifier
( Object )
Return the id of the entity. A generated id is not guaranteed to be available until after the database insert has occurred. Returns null if the entity does not yet have an id.true
true
PERSISTENCE:JAVADOC:386booleanjakarta.persistence.PersistenceUnitUtil.isLoaded
( Object ,
String )
Determine the load state of a given persistent attribute of an entity belonging to the persistence unit.true
false
PERSISTENCE:JAVADOC:387booleanjakarta.persistence.PersistenceUnitUtil.isLoaded
( Object )
Determine the load state of an entity belonging to the persistence unit. This method can be used to determine the load state of an entity passed as a reference. An entity is considered loaded if all attributes for which FetchType.EAGER has been specified have been loaded. The isLoaded(Object, String) method should be used to determine the load state of an attribute. Not doing so might lead to unintended loading of state.true
false
PERSISTENCE:JAVADOC:388booleanjakarta.persistence.PersistenceUtil.isLoaded
( Object ,
String )
Determine the load state of a given persistent attribute.true
false
PERSISTENCE:JAVADOC:389booleanjakarta.persistence.PersistenceUtil.isLoaded
( Object )
Determine the load state of an entity. This method can be used to determine the load state of an entity passed as a reference. An entity is considered loaded if all attributes for which FetchType.EAGER has been specified have been loaded. The isLoaded(Object, String) method should be used to determine the load state of an attribute. Not doing so might lead to unintended loading of state.true
false
PERSISTENCE:JAVADOC:390Objectjakarta.persistence.PessimisticLockException.getEntity
Returns the entity that caused this exception.true
true
PERSISTENCE:JAVADOC:391PessimisticLockExceptionjakarta.persistence.PessimisticLockException.PessimisticLockException
Constructs a new PessimisticLockException exception with null as its detail message.true
true
PERSISTENCE:JAVADOC:392PessimisticLockExceptionjakarta.persistence.PessimisticLockException.PessimisticLockException
( String )
Constructs a new PessimisticLockException exception with the specified detail message.true
true
PERSISTENCE:JAVADOC:393PessimisticLockExceptionjakarta.persistence.PessimisticLockException.PessimisticLockException
( String ,
Throwable )
Constructs a new PessimisticLockException exception with the specified detail message and cause.true
true
PERSISTENCE:JAVADOC:394PessimisticLockExceptionjakarta.persistence.PessimisticLockException.PessimisticLockException
( Throwable )
Constructs a new PessimisticLockException exception with the specified cause.true
true
PERSISTENCE:JAVADOC:395PessimisticLockExceptionjakarta.persistence.PessimisticLockException.PessimisticLockException
( Object )
Constructs a new PessimisticLockException exception with the specified entity.true
true
PERSISTENCE:JAVADOC:396PessimisticLockExceptionjakarta.persistence.PessimisticLockException.PessimisticLockException
( String ,
Throwable ,
Object )
Constructs a new PessimisticLockException exception with the specified detail message, cause, and entity.true
true
PERSISTENCE:JAVADOC:397PessimisticLockScopejakarta.persistence.PessimisticLockScope.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:398PessimisticLockScope[]jakarta.persistence.PessimisticLockScope.values

true
true
PERSISTENCE:JAVADOC:399intjakarta.persistence.Query.getFirstResult
The position of the first result the query object was set to retrieve. Returns 0 if setFirstResult was not applied to the query object.true
true
PERSISTENCE:JAVADOC:400FlushModeTypejakarta.persistence.Query.getFlushMode
Get the flush mode in effect for the query execution. If a flush mode has not been set for the query object, returns the flush mode in effect for the entity manager.true
true
PERSISTENCE:JAVADOC:401Mapjakarta.persistence.Query.getHints
Get the properties and hints and associated values that are in effect for the query instance.true
false
PERSISTENCE:JAVADOC:402LockModeTypejakarta.persistence.Query.getLockMode
Get the current lock mode for the query. Returns null if a lock mode has not been set on the query object.true
true
PERSISTENCE:JAVADOC:403intjakarta.persistence.Query.getMaxResults
The maximum number of results the query object was set to retrieve. Returns Integer.MAX_VALUE if setMaxResults was not applied to the query object.true
true
PERSISTENCE:JAVADOC:404Parameterjakarta.persistence.Query.getParameter
( String )
Get the parameter object corresponding to the declared parameter of the given name. This method is not required to be supported for native queries.true
true
PERSISTENCE:JAVADOC:405Parameterjakarta.persistence.Query.getParameter
( String ,
Class )
Get the parameter object corresponding to the declared parameter of the given name and type. This method is required to be supported for criteria queries only.true
true
PERSISTENCE:JAVADOC:406Parameterjakarta.persistence.Query.getParameter
( int )
Get the parameter object corresponding to the declared positional parameter with the given position. This method is not required to be supported for native queries.true
true
PERSISTENCE:JAVADOC:407Parameterjakarta.persistence.Query.getParameter
( int ,
Class )
Get the parameter object corresponding to the declared positional parameter with the given position and type. This method is not required to be supported by the provider.false
true
PERSISTENCE:JAVADOC:408Setjakarta.persistence.Query.getParameters
Get the parameter objects corresponding to the declared parameters of the query. Returns empty set if the query has no parameters. This method is not required to be supported for native queries.true
true
PERSISTENCE:JAVADOC:409Objectjakarta.persistence.Query.getParameterValue
( Parameter )
Return the input value bound to the parameter. (Note that OUT parameters are unbound.)true
true
PERSISTENCE:JAVADOC:410Objectjakarta.persistence.Query.getParameterValue
( String )
Return the input value bound to the named parameter. (Note that OUT parameters are unbound.)true
true
PERSISTENCE:JAVADOC:411Objectjakarta.persistence.Query.getParameterValue
( int )
Return the input value bound to the positional parameter. (Note that OUT parameters are unbound.)true
true
PERSISTENCE:JAVADOC:412booleanjakarta.persistence.Query.isBound
( Parameter )
Return a boolean indicating whether a value has been bound to the parameter.true
true
PERSISTENCE:JAVADOC:413Queryjakarta.persistence.Query.setLockMode
( LockModeType )
Set the lock mode type to be used for the query execution.true
true
PERSISTENCE:JAVADOC:414Queryjakarta.persistence.Query.setParameter
( Parameter ,
Object )
Bind the value of a Parameter object.true
true
PERSISTENCE:JAVADOC:415Queryjakarta.persistence.Query.setParameter
( Parameter ,
Calendar ,
TemporalType )
Bind an instance of java.util.Calendar to a Parameter object.true
true
PERSISTENCE:JAVADOC:416Queryjakarta.persistence.Query.setParameter
( Parameter ,
Date ,
TemporalType )
Bind an instance of java.util.Date to a Parameter object.true
true
PERSISTENCE:JAVADOC:417Objectjakarta.persistence.Query.unwrap
( Class )
Return an object of the specified type to allow access to the provider-specific API. If the provider's query implementation does not support the specified class, the PersistenceException is thrown.true
false
PERSISTENCE:JAVADOC:418Queryjakarta.persistence.QueryTimeoutException.getQuery
Returns the query that caused this exception.true
true
PERSISTENCE:JAVADOC:419QueryTimeoutExceptionjakarta.persistence.QueryTimeoutException.QueryTimeoutException
Constructs a new QueryTimeoutException exception with null as its detail message.true
true
PERSISTENCE:JAVADOC:420QueryTimeoutExceptionjakarta.persistence.QueryTimeoutException.QueryTimeoutException
( String )
Constructs a new QueryTimeoutException exception with the specified detail message.true
true
PERSISTENCE:JAVADOC:421QueryTimeoutExceptionjakarta.persistence.QueryTimeoutException.QueryTimeoutException
( String ,
Throwable )
Constructs a new QueryTimeoutException exception with the specified detail message and cause.true
true
PERSISTENCE:JAVADOC:422QueryTimeoutExceptionjakarta.persistence.QueryTimeoutException.QueryTimeoutException
( Throwable )
Constructs a new QueryTimeoutException exception with the specified cause.true
true
PERSISTENCE:JAVADOC:423QueryTimeoutExceptionjakarta.persistence.QueryTimeoutException.QueryTimeoutException
( Query )
Constructs a new QueryTimeoutException exception with the specified query.true
true
PERSISTENCE:JAVADOC:424QueryTimeoutExceptionjakarta.persistence.QueryTimeoutException.QueryTimeoutException
( String ,
Throwable ,
Query )
Constructs a new QueryTimeoutException exception with the specified detail message, cause, and query.true
true
PERSISTENCE:JAVADOC:425Stringjakarta.persistence.SequenceGenerator.catalog
(Optional) The catalog of the sequence generator.true
false
PERSISTENCE:JAVADOC:426Stringjakarta.persistence.SequenceGenerator.schema
(Optional) The schema of the sequence generator.true
false
PERSISTENCE:JAVADOC:427SharedCacheModejakarta.persistence.SharedCacheMode.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:428SharedCacheMode[]jakarta.persistence.SharedCacheMode.values

true
true
PERSISTENCE:JAVADOC:429Objectjakarta.persistence.Tuple.get
( TupleElement )
Get the value of the specified tuple element.true
true
PERSISTENCE:JAVADOC:430Objectjakarta.persistence.Tuple.get
( String ,
Class )
Get the value of the tuple element to which the specified alias has been assigned.true
true
PERSISTENCE:JAVADOC:431Objectjakarta.persistence.Tuple.get
( String )
Get the value of the tuple element to which the specified alias has been assigned.true
true
PERSISTENCE:JAVADOC:432Objectjakarta.persistence.Tuple.get
( int ,
Class )
Get the value of the element at the specified position in the result tuple. The first position is 0.true
true
PERSISTENCE:JAVADOC:433Objectjakarta.persistence.Tuple.get
( int )
Get the value of the element at the specified position in the result tuple. The first position is 0.true
true
PERSISTENCE:JAVADOC:434Listjakarta.persistence.Tuple.getElements
Return the tuple elements.true
true
PERSISTENCE:JAVADOC:435Object[]jakarta.persistence.Tuple.toArray
Return the values of the result tuple elements as an array.true
true
PERSISTENCE:JAVADOC:436Stringjakarta.persistence.TupleElement.getAlias
Return the alias assigned to the tuple element or null, if no alias has been assigned.true
true
PERSISTENCE:JAVADOC:437Classjakarta.persistence.TupleElement.getJavaType
Return the Java type of the tuple element.true
true
PERSISTENCE:JAVADOC:438Listjakarta.persistence.TypedQuery.getResultList
Execute a SELECT query and return the query results as a typed List.true
true
PERSISTENCE:JAVADOC:439Objectjakarta.persistence.TypedQuery.getSingleResult
Execute a SELECT query that returns a single result.true
true
PERSISTENCE:JAVADOC:440TypedQueryjakarta.persistence.TypedQuery.setFirstResult
( int )
Set the position of the first result to retrieve.true
true
PERSISTENCE:JAVADOC:441TypedQueryjakarta.persistence.TypedQuery.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:442TypedQueryjakarta.persistence.TypedQuery.setHint
( String ,
Object )
Set a query property or hint. The hints elements may be used to specify query properties and hints. Properties defined by this specification must be observed by the provider. Vendor-specific hints that are not recognized by a provider must be silently ignored. Portable applications should not rely on the standard timeout hint. Depending on the database in use and the locking mechanisms used by the provider, this hint may or may not be observed.true
false
PERSISTENCE:JAVADOC:443TypedQueryjakarta.persistence.TypedQuery.setLockMode
( LockModeType )
Set the lock mode type to be used for the query execution.true
true
PERSISTENCE:JAVADOC:444TypedQueryjakarta.persistence.TypedQuery.setMaxResults
( int )
Set the maximum number of results to retrieve.true
true
PERSISTENCE:JAVADOC:445TypedQueryjakarta.persistence.TypedQuery.setParameter
( Parameter ,
Object )
Bind the value of a Parameter object.true
true
PERSISTENCE:JAVADOC:446TypedQueryjakarta.persistence.TypedQuery.setParameter
( Parameter ,
Calendar ,
TemporalType )
Bind an instance of java.util.Calendar to a Parameter object.true
true
PERSISTENCE:JAVADOC:447TypedQueryjakarta.persistence.TypedQuery.setParameter
( Parameter ,
Date ,
TemporalType )
Bind an instance of java.util.Date to a Parameter object.true
true
PERSISTENCE:JAVADOC:448TypedQueryjakarta.persistence.TypedQuery.setParameter
( String ,
Object )
Bind an argument value to a named parameter.true
true
PERSISTENCE:JAVADOC:449TypedQueryjakarta.persistence.TypedQuery.setParameter
( String ,
Calendar ,
TemporalType )
Bind an instance of java.util.Calendar to a named parameter.true
true
PERSISTENCE:JAVADOC:450TypedQueryjakarta.persistence.TypedQuery.setParameter
( String ,
Date ,
TemporalType )
Bind an instance of java.util.Date to a named parameter.true
true
PERSISTENCE:JAVADOC:451TypedQueryjakarta.persistence.TypedQuery.setParameter
( int ,
Object )
Bind an argument value to a positional parameter.true
true
PERSISTENCE:JAVADOC:452TypedQueryjakarta.persistence.TypedQuery.setParameter
( int ,
Calendar ,
TemporalType )
Bind an instance of java.util.Calendar to a positional parameter.true
true
PERSISTENCE:JAVADOC:453TypedQueryjakarta.persistence.TypedQuery.setParameter
( int ,
Date ,
TemporalType )
Bind an instance of java.util.Date to a positional parameter.true
true
PERSISTENCE:JAVADOC:454Stringjakarta.persistence.UniqueConstraint.name
(Optional) Constraint name. A provider-chosen name will be chosen if a name is not specified.true
true
PERSISTENCE:JAVADOC:455ValidationModejakarta.persistence.ValidationMode.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:456ValidationMode[]jakarta.persistence.ValidationMode.values

true
true
PERSISTENCE:JAVADOC:711AbstractQueryjakarta.persistence.criteria.AbstractQuery.distinct
( boolean )
Specify whether duplicate query results will be eliminated. A true value will cause duplicates to be eliminated. A false value will cause duplicates to be retained. If distinct has not been specified, duplicate results must be retained.true
false
PERSISTENCE:JAVADOC:712Rootjakarta.persistence.criteria.AbstractQuery.from
( Class )
Create and add a query root corresponding to the given entity, forming a cartesian product with any existing roots.true
true
PERSISTENCE:JAVADOC:713Rootjakarta.persistence.criteria.AbstractQuery.from
( EntityType )
Create and add a query root corresponding to the given entity, forming a cartesian product with any existing roots.true
true
PERSISTENCE:JAVADOC:714Listjakarta.persistence.criteria.AbstractQuery.getGroupList
Return a list of the grouping expressions. Returns empty list if no grouping expressions have been specified. Modifications to the list do not affect the query.true
false
PERSISTENCE:JAVADOC:715Predicatejakarta.persistence.criteria.AbstractQuery.getGroupRestriction
Return the predicate that corresponds to the restriction(s) over the grouping items, or null if no restrictions have been specified.true
false
PERSISTENCE:JAVADOC:717Classjakarta.persistence.criteria.AbstractQuery.getResultType
Return the result type of the query or subquery. If a result type was specified as an argument to the createQuery or subquery method, that type will be returned. If the query was created using the createTupleQuery method, the result type is Tuple. Otherwise, the result type is Object.true
false
PERSISTENCE:JAVADOC:718Setjakarta.persistence.criteria.AbstractQuery.getRoots
Return the query roots. These are the roots that have been defined for the CriteriaQuery or Subquery itself, including any subquery roots defined as a result of correlation. Returns empty set if no roots have been defined. Modifications to the set do not affect the query.true
false
PERSISTENCE:JAVADOC:719Selectionjakarta.persistence.criteria.AbstractQuery.getSelection
Return the selection of the query, or null if no selection has been set.true
false
PERSISTENCE:JAVADOC:720AbstractQueryjakarta.persistence.criteria.AbstractQuery.groupBy
( Expression[] )
Specify the expressions that are used to form groups over the query results. Replaces the previous specified grouping expressions, if any. If no grouping expressions are specified, any previously added grouping expressions are simply removed.true
true
PERSISTENCE:JAVADOC:721AbstractQueryjakarta.persistence.criteria.AbstractQuery.groupBy
( List )
Specify the expressions that are used to form groups over the query results. Replaces the previous specified grouping expressions, if any. If no grouping expressions are specified, any previously added grouping expressions are simply removed.true
true
PERSISTENCE:JAVADOC:722AbstractQueryjakarta.persistence.criteria.AbstractQuery.having
( Expression )
Specify a restriction over the groups of the query. Replaces the previous having restriction(s), if any.true
false
PERSISTENCE:JAVADOC:723AbstractQueryjakarta.persistence.criteria.AbstractQuery.having
( Predicate[] )
Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates. Replaces the previously having added restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed.true
true
PERSISTENCE:JAVADOC:724booleanjakarta.persistence.criteria.AbstractQuery.isDistinct
Return whether duplicate query results must be eliminated or retained.true
false
PERSISTENCE:JAVADOC:726AbstractQueryjakarta.persistence.criteria.AbstractQuery.where
( Expression )
Modify the query to restrict the query results according to the specified boolean expression. Replaces the previously added restriction(s), if any.true
false
PERSISTENCE:JAVADOC:727AbstractQueryjakarta.persistence.criteria.AbstractQuery.where
( Predicate[] )
Modify the query to restrict the query results according to the conjunction of the specified restriction predicates. Replaces the previously added restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed.true
true
PERSISTENCE:JAVADOC:728CollectionAttributejakarta.persistence.criteria.CollectionJoin.getModel
Return the metamodel representation for the collection attribute.true
true
PERSISTENCE:JAVADOC:734Expressionjakarta.persistence.criteria.CriteriaBuilder.abs
( Expression )
Create an expression that returns the absolute value of its argument.true
true
PERSISTENCE:JAVADOC:735Expressionjakarta.persistence.criteria.CriteriaBuilder.all
( Subquery )
Create an all expression over the subquery results.true
true
PERSISTENCE:JAVADOC:736Predicatejakarta.persistence.criteria.CriteriaBuilder.and
( Expression ,
Expression )
Create a conjunction of the given boolean expressions.true
true
PERSISTENCE:JAVADOC:737Predicatejakarta.persistence.criteria.CriteriaBuilder.and
( Predicate[] )
Create a conjunction of the given restriction predicates. A conjunction of zero predicates is true.true
true
PERSISTENCE:JAVADOC:738Expressionjakarta.persistence.criteria.CriteriaBuilder.any
( Subquery )
Create an any expression over the subquery results. This expression is equivalent to a some expression.true
true
PERSISTENCE:JAVADOC:739CompoundSelectionjakarta.persistence.criteria.CriteriaBuilder.array
( Selection[] )
Create an array-valued selection item.true
true
PERSISTENCE:JAVADOC:741Orderjakarta.persistence.criteria.CriteriaBuilder.asc
( Expression )
Create an ordering by the ascending value of the expression.true
true
PERSISTENCE:JAVADOC:742Expressionjakarta.persistence.criteria.CriteriaBuilder.avg
( Expression )
Create an aggregate expression applying the avg operation.true
true
PERSISTENCE:JAVADOC:743Predicatejakarta.persistence.criteria.CriteriaBuilder.between
( Expression ,
Expression ,
Expression )
Create a predicate for testing whether the first argument is between the second and third arguments in value.true
true
PERSISTENCE:JAVADOC:744Predicatejakarta.persistence.criteria.CriteriaBuilder.between
( Expression ,
Comparable ,
Comparable )
Create a predicate for testing whether the first argument is between the second and third arguments in value.true
true
PERSISTENCE:JAVADOC:745Expressionjakarta.persistence.criteria.CriteriaBuilder.coalesce
( Expression ,
Expression )
Create an expression that returns null if all its arguments evaluate to null, and the value of the first non-null argument otherwise.true
false
PERSISTENCE:JAVADOC:746Expressionjakarta.persistence.criteria.CriteriaBuilder.coalesce
( Expression ,
Object )
Create an expression that returns null if all its arguments evaluate to null, and the value of the first non-null argument otherwise.true
false
PERSISTENCE:JAVADOC:747Coalescejakarta.persistence.criteria.CriteriaBuilder.coalesce
Create a coalesce expression.true
true
PERSISTENCE:JAVADOC:748Expressionjakarta.persistence.criteria.CriteriaBuilder.concat
( Expression ,
Expression )
Create an expression for string concatenation.true
true
PERSISTENCE:JAVADOC:749Expressionjakarta.persistence.criteria.CriteriaBuilder.concat
( Expression ,
String )
Create an expression for string concatenation.true
true
PERSISTENCE:JAVADOC:750Expressionjakarta.persistence.criteria.CriteriaBuilder.concat
( String ,
Expression )
Create an expression for string concatenation.true
true
PERSISTENCE:JAVADOC:751Predicatejakarta.persistence.criteria.CriteriaBuilder.conjunction
Create a conjunction (with zero conjuncts). A conjunction with zero conjuncts is true.true
true
PERSISTENCE:JAVADOC:752CompoundSelectionjakarta.persistence.criteria.CriteriaBuilder.construct
( Class ,
Selection[] )
Create a selection item corresponding to a constructor. This method is used to specify a constructor that will be applied to the results of the query execution. If the constructor is for an entity class, the resulting entities will be in the new state after the query is executed.true
true
PERSISTENCE:JAVADOC:754Expressionjakarta.persistence.criteria.CriteriaBuilder.count
( Expression )
Create an aggregate expression applying the count operation.true
true
PERSISTENCE:JAVADOC:755Expressionjakarta.persistence.criteria.CriteriaBuilder.countDistinct
( Expression )
Create an aggregate expression applying the count distinct operation.true
true
PERSISTENCE:JAVADOC:756CriteriaQueryjakarta.persistence.criteria.CriteriaBuilder.createQuery
Create a CriteriaQuery object.true
true
PERSISTENCE:JAVADOC:757CriteriaQueryjakarta.persistence.criteria.CriteriaBuilder.createQuery
( Class )
Create a CriteriaQuery object with the specified result type.true
true
PERSISTENCE:JAVADOC:758CriteriaQueryjakarta.persistence.criteria.CriteriaBuilder.createTupleQuery
Create a CriteriaQuery object that returns a tuple of objects as its result.true
true
PERSISTENCE:JAVADOC:759Expressionjakarta.persistence.criteria.CriteriaBuilder.currentDate
Create expression to return current date.true
true
PERSISTENCE:JAVADOC:760Expressionjakarta.persistence.criteria.CriteriaBuilder.currentTime
Create expression to return current time.true
true
PERSISTENCE:JAVADOC:761Expressionjakarta.persistence.criteria.CriteriaBuilder.currentTimestamp
Create expression to return current timestamp.true
true
PERSISTENCE:JAVADOC:762Orderjakarta.persistence.criteria.CriteriaBuilder.desc
( Expression )
Create an ordering by the descending value of the expression.true
true
PERSISTENCE:JAVADOC:763Expressionjakarta.persistence.criteria.CriteriaBuilder.diff
( Expression ,
Expression )
Create an expression that returns the difference between its arguments.true
true
PERSISTENCE:JAVADOC:764Expressionjakarta.persistence.criteria.CriteriaBuilder.diff
( Expression ,
Number )
Create an expression that returns the difference between its arguments.true
true
PERSISTENCE:JAVADOC:765Expressionjakarta.persistence.criteria.CriteriaBuilder.diff
( Number ,
Expression )
Create an expression that returns the difference between its arguments.true
true
PERSISTENCE:JAVADOC:766Predicatejakarta.persistence.criteria.CriteriaBuilder.disjunction
Create a disjunction (with zero disjuncts). A disjunction with zero disjuncts is false.true
true
PERSISTENCE:JAVADOC:767Predicatejakarta.persistence.criteria.CriteriaBuilder.equal
( Expression ,
Expression )
Create a predicate for testing the arguments for equality.true
true
PERSISTENCE:JAVADOC:768Predicatejakarta.persistence.criteria.CriteriaBuilder.equal
( Expression ,
Object )
Create a predicate for testing the arguments for equality.true
true
PERSISTENCE:JAVADOC:769Predicatejakarta.persistence.criteria.CriteriaBuilder.exists
( Subquery )
Create a predicate testing the existence of a subquery result.true
true
PERSISTENCE:JAVADOC:770Expressionjakarta.persistence.criteria.CriteriaBuilder.function
( String ,
Class ,
Expression[] )
Create an expression for the execution of a database function.true
false
PERSISTENCE:JAVADOC:771Predicatejakarta.persistence.criteria.CriteriaBuilder.ge
( Expression ,
Expression )
Create a predicate for testing whether the first argument is greater than or equal to the second.true
true
PERSISTENCE:JAVADOC:772Predicatejakarta.persistence.criteria.CriteriaBuilder.ge
( Expression ,
Number )
Create a predicate for testing whether the first argument is greater than or equal to the second.true
true
PERSISTENCE:JAVADOC:773Predicatejakarta.persistence.criteria.CriteriaBuilder.greaterThan
( Expression ,
Expression )
Create a predicate for testing whether the first argument is greater than the second.true
true
PERSISTENCE:JAVADOC:774Predicatejakarta.persistence.criteria.CriteriaBuilder.greaterThan
( Expression ,
Comparable )
Create a predicate for testing whether the first argument is greater than the second.true
true
PERSISTENCE:JAVADOC:775Predicatejakarta.persistence.criteria.CriteriaBuilder.greaterThanOrEqualTo
( Expression ,
Expression )
Create a predicate for testing whether the first argument is greater than or equal to the second.true
true
PERSISTENCE:JAVADOC:776Predicatejakarta.persistence.criteria.CriteriaBuilder.greaterThanOrEqualTo
( Expression ,
Comparable )
Create a predicate for testing whether the first argument is greater than or equal to the second.true
true
PERSISTENCE:JAVADOC:777Expressionjakarta.persistence.criteria.CriteriaBuilder.greatest
( Expression )
Create an aggregate expression for finding the greatest of the values (strings, dates, etc).true
true
PERSISTENCE:JAVADOC:778Predicatejakarta.persistence.criteria.CriteriaBuilder.gt
( Expression ,
Expression )
Create a predicate for testing whether the first argument is greater than the second.true
true
PERSISTENCE:JAVADOC:779Predicatejakarta.persistence.criteria.CriteriaBuilder.gt
( Expression ,
Number )
Create a predicate for testing whether the first argument is greater than the second.true
true
PERSISTENCE:JAVADOC:780Injakarta.persistence.criteria.CriteriaBuilder.in
( Expression )
Create predicate to test whether given expression is contained in a list of values.true
true
PERSISTENCE:JAVADOC:781Predicatejakarta.persistence.criteria.CriteriaBuilder.isEmpty
( Expression )
Create a predicate that tests whether a collection is empty.true
true
PERSISTENCE:JAVADOC:782Predicatejakarta.persistence.criteria.CriteriaBuilder.isFalse
( Expression )
Create a predicate testing for a false value.true
true
PERSISTENCE:JAVADOC:783Predicatejakarta.persistence.criteria.CriteriaBuilder.isMember
( Expression ,
Expression )
Create a predicate that tests whether an element is a member of a collection. If the collection is empty, the predicate will be false.true
true
PERSISTENCE:JAVADOC:784Predicatejakarta.persistence.criteria.CriteriaBuilder.isMember
( Object ,
Expression )
Create a predicate that tests whether an element is a member of a collection. If the collection is empty, the predicate will be false.true
true
PERSISTENCE:JAVADOC:785Predicatejakarta.persistence.criteria.CriteriaBuilder.isNotEmpty
( Expression )
Create a predicate that tests whether a collection is not empty.true
true
PERSISTENCE:JAVADOC:786Predicatejakarta.persistence.criteria.CriteriaBuilder.isNotMember
( Expression ,
Expression )
Create a predicate that tests whether an element is not a member of a collection. If the collection is empty, the predicate will be true.true
true
PERSISTENCE:JAVADOC:787Predicatejakarta.persistence.criteria.CriteriaBuilder.isNotMember
( Object ,
Expression )
Create a predicate that tests whether an element is not a member of a collection. If the collection is empty, the predicate will be true.true
true
PERSISTENCE:JAVADOC:788Predicatejakarta.persistence.criteria.CriteriaBuilder.isNotNull
( Expression )
Create a predicate to test whether the expression is not null.true
true
PERSISTENCE:JAVADOC:789Predicatejakarta.persistence.criteria.CriteriaBuilder.isNull
( Expression )
Create a predicate to test whether the expression is null.true
true
PERSISTENCE:JAVADOC:790Predicatejakarta.persistence.criteria.CriteriaBuilder.isTrue
( Expression )
Create a predicate testing for a true value.true
true
PERSISTENCE:JAVADOC:791Expressionjakarta.persistence.criteria.CriteriaBuilder.keys
( Map )
Create an expression that returns the keys of a map.true
true
PERSISTENCE:JAVADOC:792Predicatejakarta.persistence.criteria.CriteriaBuilder.le
( Expression ,
Expression )
Create a predicate for testing whether the first argument is less than or equal to the second.true
true
PERSISTENCE:JAVADOC:793Predicatejakarta.persistence.criteria.CriteriaBuilder.le
( Expression ,
Number )
Create a predicate for testing whether the first argument is less than or equal to the second.true
true
PERSISTENCE:JAVADOC:794Expressionjakarta.persistence.criteria.CriteriaBuilder.least
( Expression )
Create an aggregate expression for finding the least of the values (strings, dates, etc).true
true
PERSISTENCE:JAVADOC:795Expressionjakarta.persistence.criteria.CriteriaBuilder.length
( Expression )
Create expression to return length of a string.true
true
PERSISTENCE:JAVADOC:796Predicatejakarta.persistence.criteria.CriteriaBuilder.lessThan
( Expression ,
Expression )
Create a predicate for testing whether the first argument is less than the second.true
true
PERSISTENCE:JAVADOC:797Predicatejakarta.persistence.criteria.CriteriaBuilder.lessThan
( Expression ,
Comparable )
Create a predicate for testing whether the first argument is less than the second.true
true
PERSISTENCE:JAVADOC:798Predicatejakarta.persistence.criteria.CriteriaBuilder.lessThanOrEqualTo
( Expression ,
Expression )
Create a predicate for testing whether the first argument is less than or equal to the second.true
true
PERSISTENCE:JAVADOC:799Predicatejakarta.persistence.criteria.CriteriaBuilder.lessThanOrEqualTo
( Expression ,
Comparable )
Create a predicate for testing whether the first argument is less than or equal to the second.true
true
PERSISTENCE:JAVADOC:800Predicatejakarta.persistence.criteria.CriteriaBuilder.like
( Expression ,
Expression )
Create a predicate for testing whether the expression satisfies the given pattern.true
true
PERSISTENCE:JAVADOC:801Predicatejakarta.persistence.criteria.CriteriaBuilder.like
( Expression ,
String )
Create a predicate for testing whether the expression satisfies the given pattern.true
true
PERSISTENCE:JAVADOC:802Predicatejakarta.persistence.criteria.CriteriaBuilder.like
( Expression ,
Expression ,
Expression )
Create a predicate for testing whether the expression satisfies the given pattern.true
true
PERSISTENCE:JAVADOC:803Predicatejakarta.persistence.criteria.CriteriaBuilder.like
( Expression ,
Expression ,
char )
Create a predicate for testing whether the expression satisfies the given pattern.true
true
PERSISTENCE:JAVADOC:804Predicatejakarta.persistence.criteria.CriteriaBuilder.like
( Expression ,
String ,
Expression )
Create a predicate for testing whether the expression satisfies the given pattern.true
true
PERSISTENCE:JAVADOC:805Predicatejakarta.persistence.criteria.CriteriaBuilder.like
( Expression ,
String ,
char )
Create a predicate for testing whether the expression satisfies the given pattern.true
true
PERSISTENCE:JAVADOC:806Expressionjakarta.persistence.criteria.CriteriaBuilder.literal
( Object )
Create an expression for a literal.true
true
PERSISTENCE:JAVADOC:808Expressionjakarta.persistence.criteria.CriteriaBuilder.locate
( Expression ,
Expression )
Create expression to locate the position of one string within another, returning position of first character if found. The first position in a string is denoted by 1. If the string to be located is not found, 0 is returned.true
true
PERSISTENCE:JAVADOC:809Expressionjakarta.persistence.criteria.CriteriaBuilder.locate
( Expression ,
String )
Create expression to locate the position of one string within another, returning position of first character if found. The first position in a string is denoted by 1. If the string to be located is not found, 0 is returned.true
true
PERSISTENCE:JAVADOC:810Expressionjakarta.persistence.criteria.CriteriaBuilder.locate
( Expression ,
Expression ,
Expression )
Create expression to locate the position of one string within another, returning position of first character if found. The first position in a string is denoted by 1. If the string to be located is not found, 0 is returned.true
true
PERSISTENCE:JAVADOC:811Expressionjakarta.persistence.criteria.CriteriaBuilder.locate
( Expression ,
String ,
int )
Create expression to locate the position of one string within another, returning position of first character if found. The first position in a string is denoted by 1. If the string to be located is not found, 0 is returned.true
true
PERSISTENCE:JAVADOC:812Expressionjakarta.persistence.criteria.CriteriaBuilder.lower
( Expression )
Create expression for converting a string to lowercase.true
true
PERSISTENCE:JAVADOC:813Predicatejakarta.persistence.criteria.CriteriaBuilder.lt
( Expression ,
Expression )
Create a predicate for testing whether the first argument is less than the second.true
true
PERSISTENCE:JAVADOC:814Predicatejakarta.persistence.criteria.CriteriaBuilder.lt
( Expression ,
Number )
Create a predicate for testing whether the first argument is less than the second.true
true
PERSISTENCE:JAVADOC:815Expressionjakarta.persistence.criteria.CriteriaBuilder.max
( Expression )
Create an aggregate expression applying the numerical max operation.true
true
PERSISTENCE:JAVADOC:816Expressionjakarta.persistence.criteria.CriteriaBuilder.min
( Expression )
Create an aggregate expression applying the numerical min operation.true
true
PERSISTENCE:JAVADOC:817Expressionjakarta.persistence.criteria.CriteriaBuilder.mod
( Expression ,
Expression )
Create an expression that returns the modulus of its arguments.true
true
PERSISTENCE:JAVADOC:818Expressionjakarta.persistence.criteria.CriteriaBuilder.mod
( Expression ,
Integer )
Create an expression that returns the modulus of its arguments.true
true
PERSISTENCE:JAVADOC:819Expressionjakarta.persistence.criteria.CriteriaBuilder.mod
( Integer ,
Expression )
Create an expression that returns the modulus of its arguments.true
true
PERSISTENCE:JAVADOC:820Expressionjakarta.persistence.criteria.CriteriaBuilder.neg
( Expression )
Create an expression that returns the arithmetic negation of its argument.true
true
PERSISTENCE:JAVADOC:821Predicatejakarta.persistence.criteria.CriteriaBuilder.not
( Expression )
Create a negation of the given restriction.true
true
PERSISTENCE:JAVADOC:822Predicatejakarta.persistence.criteria.CriteriaBuilder.notEqual
( Expression ,
Expression )
Create a predicate for testing the arguments for inequality.true
true
PERSISTENCE:JAVADOC:823Predicatejakarta.persistence.criteria.CriteriaBuilder.notEqual
( Expression ,
Object )
Create a predicate for testing the arguments for inequality.true
true
PERSISTENCE:JAVADOC:824Predicatejakarta.persistence.criteria.CriteriaBuilder.notLike
( Expression ,
Expression )
Create a predicate for testing whether the expression does not satisfy the given pattern.true
true
PERSISTENCE:JAVADOC:825Predicatejakarta.persistence.criteria.CriteriaBuilder.notLike
( Expression ,
String )
Create a predicate for testing whether the expression does not satisfy the given pattern.true
true
PERSISTENCE:JAVADOC:826Predicatejakarta.persistence.criteria.CriteriaBuilder.notLike
( Expression ,
Expression ,
Expression )
Create a predicate for testing whether the expression does not satisfy the given pattern.true
true
PERSISTENCE:JAVADOC:827Predicatejakarta.persistence.criteria.CriteriaBuilder.notLike
( Expression ,
Expression ,
char )
Create a predicate for testing whether the expression does not satisfy the given pattern.true
true
PERSISTENCE:JAVADOC:828Predicatejakarta.persistence.criteria.CriteriaBuilder.notLike
( Expression ,
String ,
Expression )
Create a predicate for testing whether the expression does not satisfy the given pattern.true
true
PERSISTENCE:JAVADOC:829Predicatejakarta.persistence.criteria.CriteriaBuilder.notLike
( Expression ,
String ,
char )
Create a predicate for testing whether the expression does not satisfy the given pattern.true
true
PERSISTENCE:JAVADOC:830Expressionjakarta.persistence.criteria.CriteriaBuilder.nullif
( Expression ,
Expression )
Create an expression that tests whether its argument are equal, returning null if they are and the value of the first expression if they are not.true
true
PERSISTENCE:JAVADOC:831Expressionjakarta.persistence.criteria.CriteriaBuilder.nullif
( Expression ,
Object )
Create an expression that tests whether its argument are equal, returning null if they are and the value of the first expression if they are not.true
true
PERSISTENCE:JAVADOC:832Expressionjakarta.persistence.criteria.CriteriaBuilder.nullLiteral
( Class )
Create an expression for a null literal with the given type.true
false
PERSISTENCE:JAVADOC:833Predicatejakarta.persistence.criteria.CriteriaBuilder.or
( Expression ,
Expression )
Create a disjunction of the given boolean expressions.true
true
PERSISTENCE:JAVADOC:834Predicatejakarta.persistence.criteria.CriteriaBuilder.or
( Predicate[] )
Create a disjunction of the given restriction predicates. A disjunction of zero predicates is false.true
true
PERSISTENCE:JAVADOC:835ParameterExpressionjakarta.persistence.criteria.CriteriaBuilder.parameter
( Class )
Create a parameter expression.true
true
PERSISTENCE:JAVADOC:836ParameterExpressionjakarta.persistence.criteria.CriteriaBuilder.parameter
( Class ,
String )
Create a parameter expression with the given name.true
true
PERSISTENCE:JAVADOC:837Expressionjakarta.persistence.criteria.CriteriaBuilder.prod
( Expression ,
Expression )
Create an expression that returns the product of its arguments.true
true
PERSISTENCE:JAVADOC:838Expressionjakarta.persistence.criteria.CriteriaBuilder.prod
( Expression ,
Number )
Create an expression that returns the product of its arguments.true
true
PERSISTENCE:JAVADOC:839Expressionjakarta.persistence.criteria.CriteriaBuilder.prod
( Number ,
Expression )
Create an expression that returns the product of its arguments.true
true
PERSISTENCE:JAVADOC:840Expressionjakarta.persistence.criteria.CriteriaBuilder.quot
( Expression ,
Expression )
Create an expression that returns the quotient of its arguments.true
true
PERSISTENCE:JAVADOC:841Expressionjakarta.persistence.criteria.CriteriaBuilder.quot
( Expression ,
Number )
Create an expression that returns the quotient of its arguments.true
true
PERSISTENCE:JAVADOC:842Expressionjakarta.persistence.criteria.CriteriaBuilder.quot
( Number ,
Expression )
Create an expression that returns the quotient of its arguments.true
true
PERSISTENCE:JAVADOC:843SimpleCasejakarta.persistence.criteria.CriteriaBuilder.selectCase
( Expression )
Create a simple case expression.true
false
PERSISTENCE:JAVADOC:844Casejakarta.persistence.criteria.CriteriaBuilder.selectCase
Create a general case expression.true
false
PERSISTENCE:JAVADOC:845Expressionjakarta.persistence.criteria.CriteriaBuilder.size
( Expression )
Create an expression that tests the size of a collection.true
true
PERSISTENCE:JAVADOC:846Expressionjakarta.persistence.criteria.CriteriaBuilder.size
( Collection )
Create an expression that tests the size of a collection.true
true
PERSISTENCE:JAVADOC:847Expressionjakarta.persistence.criteria.CriteriaBuilder.some
( Subquery )
Create a some expression over the subquery results. This expression is equivalent to an any expression.true
true
PERSISTENCE:JAVADOC:848Expressionjakarta.persistence.criteria.CriteriaBuilder.sqrt
( Expression )
Create an expression that returns the square root of its argument.true
true
PERSISTENCE:JAVADOC:849Expressionjakarta.persistence.criteria.CriteriaBuilder.substring
( Expression ,
Expression )
Create an expression for substring extraction. Extracts a substring starting at the specified position through to end of the string. First position is 1.true
true
PERSISTENCE:JAVADOC:850Expressionjakarta.persistence.criteria.CriteriaBuilder.substring
( Expression ,
int )
Create an expression for substring extraction. Extracts a substring starting at the specified position through to end of the string. First position is 1.true
true
PERSISTENCE:JAVADOC:851Expressionjakarta.persistence.criteria.CriteriaBuilder.substring
( Expression ,
Expression ,
Expression )
Create an expression for substring extraction. Extracts a substring of given length starting at the specified position. First position is 1.true
true
PERSISTENCE:JAVADOC:852Expressionjakarta.persistence.criteria.CriteriaBuilder.substring
( Expression ,
int ,
int )
Create an expression for substring extraction. Extracts a substring of given length starting at the specified position. First position is 1.true
true
PERSISTENCE:JAVADOC:853Expressionjakarta.persistence.criteria.CriteriaBuilder.sum
( Expression )
Create an aggregate expression applying the sum operation.true
true
PERSISTENCE:JAVADOC:854Expressionjakarta.persistence.criteria.CriteriaBuilder.sum
( Expression ,
Expression )
Create an expression that returns the sum of its arguments.true
true
PERSISTENCE:JAVADOC:855Expressionjakarta.persistence.criteria.CriteriaBuilder.sum
( Expression ,
Number )
Create an expression that returns the sum of its arguments.true
true
PERSISTENCE:JAVADOC:856Expressionjakarta.persistence.criteria.CriteriaBuilder.sum
( Number ,
Expression )
Create an expression that returns the sum of its arguments.true
true
PERSISTENCE:JAVADOC:857Expressionjakarta.persistence.criteria.CriteriaBuilder.sumAsDouble
( Expression )
Create an aggregate expression applying the sum operation to a Float-valued expression, returning a Double result.true
true
PERSISTENCE:JAVADOC:858Expressionjakarta.persistence.criteria.CriteriaBuilder.sumAsLong
( Expression )
Create an aggregate expression applying the sum operation to an Integer-valued expression, returning a Long result.true
true
PERSISTENCE:JAVADOC:859Expressionjakarta.persistence.criteria.CriteriaBuilder.toBigDecimal
( Expression )
Typecast. Returns same expression object.true
true
PERSISTENCE:JAVADOC:860Expressionjakarta.persistence.criteria.CriteriaBuilder.toBigInteger
( Expression )
Typecast. Returns same expression object.true
true
PERSISTENCE:JAVADOC:861Expressionjakarta.persistence.criteria.CriteriaBuilder.toDouble
( Expression )
Typecast. Returns same expression object.true
true
PERSISTENCE:JAVADOC:862Expressionjakarta.persistence.criteria.CriteriaBuilder.toFloat
( Expression )
Typecast. Returns same expression object.true
true
PERSISTENCE:JAVADOC:863Expressionjakarta.persistence.criteria.CriteriaBuilder.toInteger
( Expression )
Typecast. Returns same expression object.true
true
PERSISTENCE:JAVADOC:864Expressionjakarta.persistence.criteria.CriteriaBuilder.toLong
( Expression )
Typecast. Returns same expression object.true
true
PERSISTENCE:JAVADOC:865Expressionjakarta.persistence.criteria.CriteriaBuilder.toString
( Expression )
Typecast. Returns same expression object.true
true
PERSISTENCE:JAVADOC:866Expressionjakarta.persistence.criteria.CriteriaBuilder.trim
( Expression )
Create expression to trim blanks from both ends of a string.true
true
PERSISTENCE:JAVADOC:867Expressionjakarta.persistence.criteria.CriteriaBuilder.trim
( Trimspec ,
Expression )
Create expression to trim blanks from a string.true
true
PERSISTENCE:JAVADOC:868Expressionjakarta.persistence.criteria.CriteriaBuilder.trim
( Expression ,
Expression )
Create expression to trim character from both ends of a string.true
false
PERSISTENCE:JAVADOC:869Expressionjakarta.persistence.criteria.CriteriaBuilder.trim
( Trimspec ,
Expression ,
Expression )
Create expression to trim character from a string.true
false
PERSISTENCE:JAVADOC:870Expressionjakarta.persistence.criteria.CriteriaBuilder.trim
( char ,
Expression )
Create expression to trim character from both ends of a string.true
false
PERSISTENCE:JAVADOC:871Expressionjakarta.persistence.criteria.CriteriaBuilder.trim
( Trimspec ,
char ,
Expression )
Create expression to trim character from a string.true
false
PERSISTENCE:JAVADOC:872CompoundSelectionjakarta.persistence.criteria.CriteriaBuilder.tuple
( Selection[] )
Create a tuple-valued selection item.true
true
PERSISTENCE:JAVADOC:874Expressionjakarta.persistence.criteria.CriteriaBuilder.upper
( Expression )
Create expression for converting a string to uppercase.true
true
PERSISTENCE:JAVADOC:875Expressionjakarta.persistence.criteria.CriteriaBuilder.values
( Map )
Create an expression that returns the values of a map.true
true
PERSISTENCE:JAVADOC:876Expressionjakarta.persistence.criteria.CriteriaBuilder.Case.otherwise
( Object )
Add an "else" clause to the case expression.true
false
PERSISTENCE:JAVADOC:877Expressionjakarta.persistence.criteria.CriteriaBuilder.Case.otherwise
( Expression )
Add an "else" clause to the case expression.true
false
PERSISTENCE:JAVADOC:878Casejakarta.persistence.criteria.CriteriaBuilder.Case.when
( Expression ,
Object )
Add a when/then clause to the case expression.true
false
PERSISTENCE:JAVADOC:879Casejakarta.persistence.criteria.CriteriaBuilder.Case.when
( Expression ,
Expression )
Add a when/then clause to the case expression.true
false
PERSISTENCE:JAVADOC:887Coalescejakarta.persistence.criteria.CriteriaBuilder.Coalesce.value
( Object )
Add an argument to the coalesce expression.true
false
PERSISTENCE:JAVADOC:888Coalescejakarta.persistence.criteria.CriteriaBuilder.Coalesce.value
( Expression )
Add an argument to the coalesce expression.true
false
PERSISTENCE:JAVADOC:896Expressionjakarta.persistence.criteria.CriteriaBuilder.In.getExpression
Return the expression to be tested against the list of values.true
true
PERSISTENCE:JAVADOC:897Injakarta.persistence.criteria.CriteriaBuilder.In.value
( Object )
Add to list of values to be tested against.true
true
PERSISTENCE:JAVADOC:898Injakarta.persistence.criteria.CriteriaBuilder.In.value
( Expression )
Add to list of values to be tested against.true
true
PERSISTENCE:JAVADOC:903Expressionjakarta.persistence.criteria.CriteriaBuilder.SimpleCase.getExpression
Return the expression to be tested against the conditions.true
false
PERSISTENCE:JAVADOC:904Expressionjakarta.persistence.criteria.CriteriaBuilder.SimpleCase.otherwise
( Object )
Add an "else" clause to the case expression.true
false
PERSISTENCE:JAVADOC:905Expressionjakarta.persistence.criteria.CriteriaBuilder.SimpleCase.otherwise
( Expression )
Add an "else" clause to the case expression.true
false
PERSISTENCE:JAVADOC:906SimpleCasejakarta.persistence.criteria.CriteriaBuilder.SimpleCase.when
( Object ,
Object )
Add a when/then clause to the case expression.true
false
PERSISTENCE:JAVADOC:907SimpleCasejakarta.persistence.criteria.CriteriaBuilder.SimpleCase.when
( Object ,
Expression )
Add a when/then clause to the case expression.true
false
PERSISTENCE:JAVADOC:915Trimspecjakarta.persistence.criteria.CriteriaBuilder.Trimspec.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:916Trimspec[]jakarta.persistence.criteria.CriteriaBuilder.Trimspec.values

true
true
PERSISTENCE:JAVADOC:917CriteriaQueryjakarta.persistence.criteria.CriteriaQuery.distinct
( boolean )
Specify whether duplicate query results will be eliminated. A true value will cause duplicates to be eliminated. A false value will cause duplicates to be retained. If distinct has not been specified, duplicate results must be retained. This method only overrides the return type of the corresponding AbstractQuery method.true
true
PERSISTENCE:JAVADOC:918Listjakarta.persistence.criteria.CriteriaQuery.getOrderList
Return the ordering expressions in order of precedence. Returns empty list if no ordering expressions have been specified. Modifications to the list do not affect the query.true
true
PERSISTENCE:JAVADOC:919Setjakarta.persistence.criteria.CriteriaQuery.getParameters
Return the parameters of the query. Returns empty set if there are no parameters. Modifications to the set do not affect the query.true
true
PERSISTENCE:JAVADOC:920CriteriaQueryjakarta.persistence.criteria.CriteriaQuery.groupBy
( Expression[] )
Specify the expressions that are used to form groups over the query results. Replaces the previous specified grouping expressions, if any. If no grouping expressions are specified, any previously added grouping expressions are simply removed. This method only overrides the return type of the corresponding AbstractQuery method.true
true
PERSISTENCE:JAVADOC:921CriteriaQueryjakarta.persistence.criteria.CriteriaQuery.groupBy
( List )
Specify the expressions that are used to form groups over the query results. Replaces the previous specified grouping expressions, if any. If no grouping expressions are specified, any previously added grouping expressions are simply removed. This method only overrides the return type of the corresponding AbstractQuery method.true
true
PERSISTENCE:JAVADOC:922CriteriaQueryjakarta.persistence.criteria.CriteriaQuery.having
( Expression )
Specify a restriction over the groups of the query. Replaces the previous having restriction(s), if any. This method only overrides the return type of the corresponding AbstractQuery method.true
true
PERSISTENCE:JAVADOC:923CriteriaQueryjakarta.persistence.criteria.CriteriaQuery.having
( Predicate[] )
Specify restrictions over the groups of the query according the conjunction of the specified restriction predicates. Replaces the previously added having restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed. This method only overrides the return type of the corresponding AbstractQuery method.true
true
PERSISTENCE:JAVADOC:924CriteriaQueryjakarta.persistence.criteria.CriteriaQuery.multiselect
( Selection[] )
Specify the selection items that are to be returned in the query result. Replaces the previously specified selection(s), if any. The type of the result of the query execution depends on the specification of the type of the criteria query object created as well as the arguments to the multiselect method. An argument to the multiselect method must not be a tuple- or array-valued compound selection item. The semantics of this method are as follows: If the type of the criteria query is CriteriaQuery #060;Tuple #062; (i.e., a criteria query object created by either the createTupleQuery method or by passing a Tuple class argument to the createQuery method), a Tuple object corresponding to the arguments of the multiselect method, in the specified order, will be instantiated and returned for each row that results from the query execution. If the type of the criteria query is CriteriaQuery #060;X #062; for some user-defined class X (i.e., a criteria query object created by passing a X class argument to the createQuery method), the arguments to the multiselect method will be passed to the X constructor and an instance of type X will be returned for each row. If the type of the criteria query is CriteriaQuery #060;X[] #062; for some class X, an instance of type X[] will be returned for each row. The elements of the array will correspond to the arguments of the multiselect method, in the specified order. If the type of the criteria query is CriteriaQuery #060;Object #062; or if the criteria query was created without specifying a type, and only a single argument is passed to the multiselect method, an instance of type Object will be returned for each row. If the type of the criteria query is CriteriaQuery #060;Object #062; or if the criteria query was created without specifying a type, and more than one argument is passed to the multiselect method, an instance of type Object[] will be instantiated and returned for each row. The elements of the array will correspond to the arguments to the multiselect method, in the specified order.true
true
PERSISTENCE:JAVADOC:926CriteriaQueryjakarta.persistence.criteria.CriteriaQuery.multiselect
( List )
Specify the selection items that are to be returned in the query result. Replaces the previously specified selection(s), if any. The type of the result of the query execution depends on the specification of the type of the criteria query object created as well as the argument to the multiselect method. An element of the list passed to the multiselect method must not be a tuple- or array-valued compound selection item. The semantics of this method are as follows: If the type of the criteria query is CriteriaQuery #060;Tuple #062; (i.e., a criteria query object created by either the createTupleQuery method or by passing a Tuple class argument to the createQuery method), a Tuple object corresponding to the elements of the list passed to the multiselect method, in the specified order, will be instantiated and returned for each row that results from the query execution. If the type of the criteria query is CriteriaQuery #060;X #062; for some user-defined class X (i.e., a criteria query object created by passing a X class argument to the createQuery method), the elements of the list passed to the multiselect method will be passed to the X constructor and an instance of type X will be returned for each row. If the type of the criteria query is CriteriaQuery #060;X[] #062; for some class X, an instance of type X[] will be returned for each row. The elements of the array will correspond to the elements of the list passed to the multiselect method, in the specified order. If the type of the criteria query is CriteriaQuery #060;Object #062; or if the criteria query was created without specifying a type, and the list passed to the multiselect method contains only a single element, an instance of type Object will be returned for each row. If the type of the criteria query is CriteriaQuery #060;Object #062; or if the criteria query was created without specifying a type, and the list passed to the multiselect method contains more than one element, an instance of type Object[] will be instantiated and returned for each row. The elements of the array will correspond to the elements of the list passed to the multiselect method, in the specified order.true
true
PERSISTENCE:JAVADOC:928CriteriaQueryjakarta.persistence.criteria.CriteriaQuery.orderBy
( Order[] )
Specify the ordering expressions that are used to order the query results. Replaces the previous ordering expressions, if any. If no ordering expressions are specified, the previous ordering, if any, is simply removed, and results will be returned in no particular order. The left-to-right sequence of the ordering expressions determines the precedence, whereby the leftmost has highest precedence.true
true
PERSISTENCE:JAVADOC:929CriteriaQueryjakarta.persistence.criteria.CriteriaQuery.orderBy
( List )
Specify the ordering expressions that are used to order the query results. Replaces the previous ordering expressions, if any. If no ordering expressions are specified, the previous ordering, if any, is simply removed, and results will be returned in no particular order. The order of the ordering expressions in the list determines the precedence, whereby the first element in the list has highest precedence.true
true
PERSISTENCE:JAVADOC:930CriteriaQueryjakarta.persistence.criteria.CriteriaQuery.select
( Selection )
Specify the item that is to be returned in the query result. Replaces the previously specified selection(s), if any. Note: Applications using the string-based API may need to specify the type of the select item when it results from a get or join operation and the query result type is specified. For example: CriteriaQuery #060;String #062; q = cb.createQuery(String.class); Root #060;Order #062; order = q.from(Order.class); q.select(order.get("shippingAddress"). #060;String #062;get("state")); CriteriaQuery #060;Product #062; q2 = cb.createQuery(Product.class); q2.select(q2.from(Order.class) .join("items") . #060;Item,Product #062;join("product"));true
true
PERSISTENCE:JAVADOC:932CriteriaQueryjakarta.persistence.criteria.CriteriaQuery.where
( Expression )
Modify the query to restrict the query result according to the specified boolean expression. Replaces the previously added restriction(s), if any. This method only overrides the return type of the corresponding AbstractQuery method.true
true
PERSISTENCE:JAVADOC:933CriteriaQueryjakarta.persistence.criteria.CriteriaQuery.where
( Predicate[] )
Modify the query to restrict the query result according to the conjunction of the specified restriction predicates. Replaces the previously added restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed. This method only overrides the return type of the corresponding AbstractQuery method.true
true
PERSISTENCE:JAVADOC:951Expressionjakarta.persistence.criteria.Expression.as
( Class )
Perform a typecast upon the expression, returning a new expression object. This method does not cause type conversion: the runtime type is not changed. Warning: may result in a runtime failure.true
false
PERSISTENCE:JAVADOC:952Predicatejakarta.persistence.criteria.Expression.in
( Object[] )
Create a predicate to test whether the expression is a member of the argument list.true
true
PERSISTENCE:JAVADOC:953Predicatejakarta.persistence.criteria.Expression.in
( Expression[] )
Create a predicate to test whether the expression is a member of the argument list.true
true
PERSISTENCE:JAVADOC:954Predicatejakarta.persistence.criteria.Expression.in
( Collection )
Create a predicate to test whether the expression is a member of the collection.true
true
PERSISTENCE:JAVADOC:955Predicatejakarta.persistence.criteria.Expression.in
( Expression )
Create a predicate to test whether the expression is a member of the collection.true
true
PERSISTENCE:JAVADOC:956Predicatejakarta.persistence.criteria.Expression.isNotNull
Create a predicate to test whether the expression is not null.true
true
PERSISTENCE:JAVADOC:957Predicatejakarta.persistence.criteria.Expression.isNull
Create a predicate to test whether the expression is null.true
true
PERSISTENCE:JAVADOC:962Attributejakarta.persistence.criteria.Fetch.getAttribute
Return the metamodel attribute corresponding to the fetch join.true
true
PERSISTENCE:JAVADOC:963JoinTypejakarta.persistence.criteria.Fetch.getJoinType
Return the join type used in the fetch join.true
true
PERSISTENCE:JAVADOC:964FetchParentjakarta.persistence.criteria.Fetch.getParent
Return the parent of the fetched item.true
true
PERSISTENCE:JAVADOC:974Fetchjakarta.persistence.criteria.FetchParent.fetch
( SingularAttribute )
Create a fetch join to the specified single-valued attribute using an inner join.true
true
PERSISTENCE:JAVADOC:975Fetchjakarta.persistence.criteria.FetchParent.fetch
( SingularAttribute ,
JoinType )
Create a fetch join to the specified single-valued attribute using the given join type.true
true
PERSISTENCE:JAVADOC:976Fetchjakarta.persistence.criteria.FetchParent.fetch
( PluralAttribute )
Create a fetch join to the specified collection-valued attribute using an inner join.true
true
PERSISTENCE:JAVADOC:977Fetchjakarta.persistence.criteria.FetchParent.fetch
( PluralAttribute ,
JoinType )
Create a fetch join to the specified collection-valued attribute using the given join type.true
true
PERSISTENCE:JAVADOC:978Fetchjakarta.persistence.criteria.FetchParent.fetch
( String )
Create a fetch join to the specified attribute using an inner join.true
true
PERSISTENCE:JAVADOC:980Fetchjakarta.persistence.criteria.FetchParent.fetch
( String ,
JoinType )
Create a fetch join to the specified attribute using the given join type.true
true
PERSISTENCE:JAVADOC:982Setjakarta.persistence.criteria.FetchParent.getFetches
Return the fetch joins that have been made from this type. Returns empty set if no fetch joins have been made from this type. Modifications to the set do not affect the query.true
true
PERSISTENCE:JAVADOC:983Fromjakarta.persistence.criteria.From.getCorrelationParent
Returns the parent From object from which the correlated From object has been obtained through correlation (use of a Subquery correlate method).true
true
PERSISTENCE:JAVADOC:985Setjakarta.persistence.criteria.From.getJoins
Return the joins that have been made from this bound type. Returns empty set if no joins have been made from this bound type. Modifications to the set do not affect the query.true
true
PERSISTENCE:JAVADOC:986booleanjakarta.persistence.criteria.From.isCorrelated
Whether the From object has been obtained as a result of correlation (use of a Subquery correlate method).true
true
PERSISTENCE:JAVADOC:987Joinjakarta.persistence.criteria.From.join
( SingularAttribute )
Create an inner join to the specified single-valued attribute.true
true
PERSISTENCE:JAVADOC:988Joinjakarta.persistence.criteria.From.join
( SingularAttribute ,
JoinType )
Create a join to the specified single-valued attribute using the given join type.true
true
PERSISTENCE:JAVADOC:989CollectionJoinjakarta.persistence.criteria.From.join
( CollectionAttribute )
Create an inner join to the specified Collection-valued attribute.true
true
PERSISTENCE:JAVADOC:990SetJoinjakarta.persistence.criteria.From.join
( SetAttribute )
Create an inner join to the specified Set-valued attribute.true
true
PERSISTENCE:JAVADOC:991ListJoinjakarta.persistence.criteria.From.join
( ListAttribute )
Create an inner join to the specified List-valued attribute.true
true
PERSISTENCE:JAVADOC:992MapJoinjakarta.persistence.criteria.From.join
( MapAttribute )
Create an inner join to the specified Map-valued attribute.true
true
PERSISTENCE:JAVADOC:993CollectionJoinjakarta.persistence.criteria.From.join
( CollectionAttribute ,
JoinType )
Create a join to the specified Collection-valued attribute using the given join type.true
true
PERSISTENCE:JAVADOC:994SetJoinjakarta.persistence.criteria.From.join
( SetAttribute ,
JoinType )
Create a join to the specified Set-valued attribute using the given join type.true
true
PERSISTENCE:JAVADOC:995ListJoinjakarta.persistence.criteria.From.join
( ListAttribute ,
JoinType )
Create a join to the specified List-valued attribute using the given join type.true
true
PERSISTENCE:JAVADOC:996MapJoinjakarta.persistence.criteria.From.join
( MapAttribute ,
JoinType )
Create a join to the specified Map-valued attribute using the given join type.true
true
PERSISTENCE:JAVADOC:997Joinjakarta.persistence.criteria.From.join
( String )
Create an inner join to the specified attribute.true
true
PERSISTENCE:JAVADOC:999Joinjakarta.persistence.criteria.From.join
( String ,
JoinType )
Create a join to the specified attribute using the given join type.true
true
PERSISTENCE:JAVADOC:1001CollectionJoinjakarta.persistence.criteria.From.joinCollection
( String )
Create an inner join to the specified Collection-valued attribute.true
true
PERSISTENCE:JAVADOC:1003CollectionJoinjakarta.persistence.criteria.From.joinCollection
( String ,
JoinType )
Create a join to the specified Collection-valued attribute using the given join type.true
true
PERSISTENCE:JAVADOC:1005ListJoinjakarta.persistence.criteria.From.joinList
( String )
Create an inner join to the specified List-valued attribute.true
true
PERSISTENCE:JAVADOC:1007ListJoinjakarta.persistence.criteria.From.joinList
( String ,
JoinType )
Create a join to the specified List-valued attribute using the given join type.true
true
PERSISTENCE:JAVADOC:1009MapJoinjakarta.persistence.criteria.From.joinMap
( String )
Create an inner join to the specified Map-valued attribute.true
true
PERSISTENCE:JAVADOC:1011MapJoinjakarta.persistence.criteria.From.joinMap
( String ,
JoinType )
Create a join to the specified Map-valued attribute using the given join type.true
true
PERSISTENCE:JAVADOC:1013SetJoinjakarta.persistence.criteria.From.joinSet
( String )
Create an inner join to the specified Set-valued attribute.true
true
PERSISTENCE:JAVADOC:1015SetJoinjakarta.persistence.criteria.From.joinSet
( String ,
JoinType )
Create a join to the specified Set-valued attribute using the given join type.true
true
PERSISTENCE:JAVADOC:1035Attributejakarta.persistence.criteria.Join.getAttribute
Return the metamodel attribute corresponding to the join.true
true
PERSISTENCE:JAVADOC:1036JoinTypejakarta.persistence.criteria.Join.getJoinType
Return the join type.true
true
PERSISTENCE:JAVADOC:1037Fromjakarta.persistence.criteria.Join.getParent
Return the parent of the join.true
true
PERSISTENCE:JAVADOC:1072JoinTypejakarta.persistence.criteria.JoinType.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:1073JoinType[]jakarta.persistence.criteria.JoinType.values

true
true
PERSISTENCE:JAVADOC:1074ListAttributejakarta.persistence.criteria.ListJoin.getModel
Return the metamodel representation for the list attribute.true
true
PERSISTENCE:JAVADOC:1075Expressionjakarta.persistence.criteria.ListJoin.index
Create an expression that corresponds to the index of the object in the referenced association or element collection. This method must only be invoked upon an object that represents an association or element collection for which an order column has been defined.true
true
PERSISTENCE:JAVADOC:1077Expressionjakarta.persistence.criteria.MapJoin.entry
Create an expression that corresponds to the map entry.true
true
PERSISTENCE:JAVADOC:1078MapAttributejakarta.persistence.criteria.MapJoin.getModel
Return the metamodel representation for the map attribute.true
true
PERSISTENCE:JAVADOC:1079Pathjakarta.persistence.criteria.MapJoin.key
Create a path expression that corresponds to the map key.true
true
PERSISTENCE:JAVADOC:1080Pathjakarta.persistence.criteria.MapJoin.value
Create a path expression that corresponds to the map value. This method is for stylistic use only: it just returns this.true
true
PERSISTENCE:JAVADOC:1082Expressionjakarta.persistence.criteria.Order.getExpression
Return the expression that is used for ordering.true
true
PERSISTENCE:JAVADOC:1083booleanjakarta.persistence.criteria.Order.isAscending
Whether ascending ordering is in effect.true
true
PERSISTENCE:JAVADOC:1084Orderjakarta.persistence.criteria.Order.reverse
Switch the ordering.true
true
PERSISTENCE:JAVADOC:1096Pathjakarta.persistence.criteria.Path.get
( SingularAttribute )
Create a path corresponding to the referenced single-valued attribute.true
true
PERSISTENCE:JAVADOC:1097Expressionjakarta.persistence.criteria.Path.get
( PluralAttribute )
Create a path corresponding to the referenced collection-valued attribute.true
true
PERSISTENCE:JAVADOC:1098Expressionjakarta.persistence.criteria.Path.get
( MapAttribute )
Create a path corresponding to the referenced map-valued attribute.true
true
PERSISTENCE:JAVADOC:1099Pathjakarta.persistence.criteria.Path.get
( String )
Create a path corresponding to the referenced attribute. Note: Applications using the string-based API may need to specify the type resulting from the get operation in order to avoid the use of Path variables. For example: CriteriaQuery #060;Person #062; q = cb.createQuery(Person.class); Root #060;Person #062; p = q.from(Person.class); q.select(p) .where(cb.isMember("joe", p. #060;Set #060;String #062; #062;get("nicknames"))); rather than: CriteriaQuery #060;Person #062; q = cb.createQuery(Person.class); Root #060;Person #062; p = q.from(Person.class); Path #060;Set #060;String #062; #062; nicknames = p.get("nicknames"); q.select(p) .where(cb.isMember("joe", nicknames));true
true
PERSISTENCE:JAVADOC:1102Bindablejakarta.persistence.criteria.Path.getModel
Return the bindable object that corresponds to the path expression.true
true
PERSISTENCE:JAVADOC:1103Pathjakarta.persistence.criteria.Path.getParentPath
Return the parent "node" in the path or null if no parent.true
true
PERSISTENCE:JAVADOC:1104Expressionjakarta.persistence.criteria.Path.type
Create an expression corresponding to the type of the path.true
true
PERSISTENCE:JAVADOC:1112PluralAttributejakarta.persistence.criteria.PluralJoin.getModel
Return the metamodel representation for the collection-valued attribute corresponding to the join.true
true
PERSISTENCE:JAVADOC:1116Listjakarta.persistence.criteria.Predicate.getExpressions
Return the top-level conjuncts or disjuncts of the predicate. Returns empty list if there are no top-level conjuncts or disjuncts of the predicate. Modifications to the list do not affect the query.true
true
PERSISTENCE:JAVADOC:1117BooleanOperatorjakarta.persistence.criteria.Predicate.getOperator
Return the boolean operator for the predicate. If the predicate is simple, this is AND.true
true
PERSISTENCE:JAVADOC:1118booleanjakarta.persistence.criteria.Predicate.isNegated
Whether the predicate has been created from another predicate by applying the Predicate.not() method or the CriteriaBuilder.not() method.true
true
PERSISTENCE:JAVADOC:1119Predicatejakarta.persistence.criteria.Predicate.not
Create a negation of the predicate.true
true
PERSISTENCE:JAVADOC:1127BooleanOperatorjakarta.persistence.criteria.Predicate.BooleanOperator.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:1128BooleanOperator[]jakarta.persistence.criteria.Predicate.BooleanOperator.values

true
true
PERSISTENCE:JAVADOC:1129EntityTypejakarta.persistence.criteria.Root.getModel
Return the metamodel entity corresponding to the root.true
true
PERSISTENCE:JAVADOC:1164Selectionjakarta.persistence.criteria.Selection.alias
( String )
Assigns an alias to the selection item. Once assigned, an alias cannot be changed or reassigned. Returns the same selection item.true
true
PERSISTENCE:JAVADOC:1165Listjakarta.persistence.criteria.Selection.getCompoundSelectionItems
Return the selection items composing a compound selection. Modifications to the list do not affect the query.true
true
PERSISTENCE:JAVADOC:1167booleanjakarta.persistence.criteria.Selection.isCompoundSelection
Whether the selection item is a compound selection.true
true
PERSISTENCE:JAVADOC:1170SetAttributejakarta.persistence.criteria.SetJoin.getModel
Return the metamodel representation for the set attribute.true
true
PERSISTENCE:JAVADOC:1172Rootjakarta.persistence.criteria.Subquery.correlate
( Root )
Create a subquery root correlated to a root of the enclosing query.true
true
PERSISTENCE:JAVADOC:1173Joinjakarta.persistence.criteria.Subquery.correlate
( Join )
Create a subquery join object correlated to a join object of the enclosing query.true
true
PERSISTENCE:JAVADOC:1174CollectionJoinjakarta.persistence.criteria.Subquery.correlate
( CollectionJoin )
Create a subquery collection join object correlated to a collection join object of the enclosing query.true
true
PERSISTENCE:JAVADOC:1175SetJoinjakarta.persistence.criteria.Subquery.correlate
( SetJoin )
Create a subquery set join object correlated to a set join object of the enclosing query.true
true
PERSISTENCE:JAVADOC:1176ListJoinjakarta.persistence.criteria.Subquery.correlate
( ListJoin )
Create a subquery list join object correlated to a list join object of the enclosing query.true
true
PERSISTENCE:JAVADOC:1177MapJoinjakarta.persistence.criteria.Subquery.correlate
( MapJoin )
Create a subquery map join object correlated to a map join object of the enclosing query.true
true
PERSISTENCE:JAVADOC:1178Subqueryjakarta.persistence.criteria.Subquery.distinct
( boolean )
Specify whether duplicate query results will be eliminated. A true value will cause duplicates to be eliminated. A false value will cause duplicates to be retained. If distinct has not been specified, duplicate results must be retained. This method only overrides the return type of the corresponding AbstractQuery method.true
true
PERSISTENCE:JAVADOC:1179Setjakarta.persistence.criteria.Subquery.getCorrelatedJoins
Return the correlated joins of the subquery. Returns empty set if the subquery has no correlated joins. Modifications to the set do not affect the query.true
true
PERSISTENCE:JAVADOC:1180AbstractQueryjakarta.persistence.criteria.Subquery.getParent
Return the query of which this is a subquery. This must be a CriteriaQuery or a Subquery.true
true
PERSISTENCE:JAVADOC:1181Expressionjakarta.persistence.criteria.Subquery.getSelection
Return the selection expression.true
true
PERSISTENCE:JAVADOC:1182Subqueryjakarta.persistence.criteria.Subquery.groupBy
( Expression[] )
Specify the expressions that are used to form groups over the subquery results. Replaces the previous specified grouping expressions, if any. If no grouping expressions are specified, any previously added grouping expressions are simply removed. This method only overrides the return type of the corresponding AbstractQuery method.true
true
PERSISTENCE:JAVADOC:1183Subqueryjakarta.persistence.criteria.Subquery.groupBy
( List )
Specify the expressions that are used to form groups over the subquery results. Replaces the previous specified grouping expressions, if any. If no grouping expressions are specified, any previously added grouping expressions are simply removed. This method only overrides the return type of the corresponding AbstractQuery method.true
true
PERSISTENCE:JAVADOC:1184Subqueryjakarta.persistence.criteria.Subquery.having
( Expression )
Specify a restriction over the groups of the subquery. Replaces the previous having restriction(s), if any. This method only overrides the return type of the corresponding AbstractQuery method.true
true
PERSISTENCE:JAVADOC:1185Subqueryjakarta.persistence.criteria.Subquery.having
( Predicate[] )
Specify restrictions over the groups of the subquery according the conjunction of the specified restriction predicates. Replaces the previously added having restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed. This method only overrides the return type of the corresponding AbstractQuery method.true
true
PERSISTENCE:JAVADOC:1186Subqueryjakarta.persistence.criteria.Subquery.select
( Expression )
Specify the item that is to be returned as the subquery result. Replaces the previously specified selection, if any.true
true
PERSISTENCE:JAVADOC:1187Subqueryjakarta.persistence.criteria.Subquery.where
( Expression )
Modify the subquery to restrict the result according to the specified boolean expression. Replaces the previously added restriction(s), if any. This method only overrides the return type of the corresponding AbstractQuery method.true
true
PERSISTENCE:JAVADOC:1188Subqueryjakarta.persistence.criteria.Subquery.where
( Predicate[] )
Modify the subquery to restrict the result according to the conjunction of the specified restriction predicates. Replaces the previously added restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed. This method only overrides the return type of the corresponding AbstractQuery method.true
true
PERSISTENCE:JAVADOC:1213ManagedTypejakarta.persistence.metamodel.Attribute.getDeclaringType
Return the managed type representing the type in which the attribute was declared.true
true
PERSISTENCE:JAVADOC:1214Memberjakarta.persistence.metamodel.Attribute.getJavaMember
Return the java.lang.reflect.Member for the represented attribute.true
true
PERSISTENCE:JAVADOC:1215Classjakarta.persistence.metamodel.Attribute.getJavaType
Return the Java type of the represented attribute.true
true
PERSISTENCE:JAVADOC:1216Stringjakarta.persistence.metamodel.Attribute.getName
Return the name of the attribute.true
true
PERSISTENCE:JAVADOC:1217PersistentAttributeTypejakarta.persistence.metamodel.Attribute.getPersistentAttributeType
Return the persistent attribute type for the attribute.true
true
PERSISTENCE:JAVADOC:1218booleanjakarta.persistence.metamodel.Attribute.isAssociation
Is the attribute an association.true
true
PERSISTENCE:JAVADOC:1219booleanjakarta.persistence.metamodel.Attribute.isCollection
Is the attribute collection-valued (represents a Collection, Set, List, or Map).true
true
PERSISTENCE:JAVADOC:1220PersistentAttributeTypejakarta.persistence.metamodel.Attribute.PersistentAttributeType.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:1221PersistentAttributeType[]jakarta.persistence.metamodel.Attribute.PersistentAttributeType.values

true
true
PERSISTENCE:JAVADOC:1224Classjakarta.persistence.metamodel.Bindable.getBindableJavaType
Return the Java type of the represented object. If the bindable type of the object is PLURAL_ATTRIBUTE, the Java element type is returned. If the bindable type is SINGULAR_ATTRIBUTE or ENTITY_TYPE, the Java type of the represented entity or attribute is returned.true
true
PERSISTENCE:JAVADOC:1225BindableTypejakarta.persistence.metamodel.Bindable.getBindableType
Return the bindable type of the represented object.true
true
PERSISTENCE:JAVADOC:1226BindableTypejakarta.persistence.metamodel.Bindable.BindableType.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:1227BindableType[]jakarta.persistence.metamodel.Bindable.BindableType.values

true
true
PERSISTENCE:JAVADOC:1280Stringjakarta.persistence.metamodel.EntityType.getName
Return the entity name.true
true
PERSISTENCE:JAVADOC:1297SingularAttributejakarta.persistence.metamodel.IdentifiableType.getDeclaredId
( Class )
Return the attribute that corresponds to the id attribute declared by the entity or mapped superclass.true
true
PERSISTENCE:JAVADOC:1299SingularAttributejakarta.persistence.metamodel.IdentifiableType.getDeclaredVersion
( Class )
Return the attribute that corresponds to the version attribute declared by the entity or mapped superclass.true
true
PERSISTENCE:JAVADOC:1301SingularAttributejakarta.persistence.metamodel.IdentifiableType.getId
( Class )
Return the attribute that corresponds to the id attribute of the entity or mapped superclass.true
true
PERSISTENCE:JAVADOC:1303Setjakarta.persistence.metamodel.IdentifiableType.getIdClassAttributes
Return the attributes corresponding to the id class of the identifiable type.true
true
PERSISTENCE:JAVADOC:1305Typejakarta.persistence.metamodel.IdentifiableType.getIdType
Return the type that represents the type of the id.true
true
PERSISTENCE:JAVADOC:1306IdentifiableTypejakarta.persistence.metamodel.IdentifiableType.getSupertype
Return the identifiable type that corresponds to the most specific mapped superclass or entity extended by the entity or mapped superclass.true
true
PERSISTENCE:JAVADOC:1307SingularAttributejakarta.persistence.metamodel.IdentifiableType.getVersion
( Class )
Return the attribute that corresponds to the version attribute of the entity or mapped superclass.true
true
PERSISTENCE:JAVADOC:1309booleanjakarta.persistence.metamodel.IdentifiableType.hasSingleIdAttribute
Whether the identifiable type has a single id attribute. Returns true for a simple id or embedded id; returns false for an idclass.true
true
PERSISTENCE:JAVADOC:1310booleanjakarta.persistence.metamodel.IdentifiableType.hasVersionAttribute
Whether the identifiable type has a version attribute.true
true
PERSISTENCE:JAVADOC:1363Attributejakarta.persistence.metamodel.ManagedType.getAttribute
( String )
Return the attribute of the managed type that corresponds to the specified name.true
true
PERSISTENCE:JAVADOC:1365Setjakarta.persistence.metamodel.ManagedType.getAttributes
Return the attributes of the managed type.true
true
PERSISTENCE:JAVADOC:1366CollectionAttributejakarta.persistence.metamodel.ManagedType.getCollection
( String ,
Class )
Return the Collection-valued attribute of the managed type that corresponds to the specified name and Java element type.true
true
PERSISTENCE:JAVADOC:1368CollectionAttributejakarta.persistence.metamodel.ManagedType.getCollection
( String )
Return the Collection-valued attribute of the managed type that corresponds to the specified name.true
true
PERSISTENCE:JAVADOC:1370Attributejakarta.persistence.metamodel.ManagedType.getDeclaredAttribute
( String )
Return the attribute declared by the managed type that corresponds to the specified name.true
true
PERSISTENCE:JAVADOC:1372Setjakarta.persistence.metamodel.ManagedType.getDeclaredAttributes
Return the attributes declared by the managed type. Returns empty set if the managed type has no declared attributes.true
true
PERSISTENCE:JAVADOC:1373CollectionAttributejakarta.persistence.metamodel.ManagedType.getDeclaredCollection
( String ,
Class )
Return the Collection-valued attribute declared by the managed type that corresponds to the specified name and Java element type.true
true
PERSISTENCE:JAVADOC:1375CollectionAttributejakarta.persistence.metamodel.ManagedType.getDeclaredCollection
( String )
Return the Collection-valued attribute declared by the managed type that corresponds to the specified name.true
true
PERSISTENCE:JAVADOC:1377ListAttributejakarta.persistence.metamodel.ManagedType.getDeclaredList
( String ,
Class )
Return the List-valued attribute declared by the managed type that corresponds to the specified name and Java element type.true
true
PERSISTENCE:JAVADOC:1379ListAttributejakarta.persistence.metamodel.ManagedType.getDeclaredList
( String )
Return the List-valued attribute declared by the managed type that corresponds to the specified name.true
true
PERSISTENCE:JAVADOC:1381MapAttributejakarta.persistence.metamodel.ManagedType.getDeclaredMap
( String ,
Class ,
Class )
Return the Map-valued attribute declared by the managed type that corresponds to the specified name and Java key and value types.true
true
PERSISTENCE:JAVADOC:1383MapAttributejakarta.persistence.metamodel.ManagedType.getDeclaredMap
( String )
Return the Map-valued attribute declared by the managed type that corresponds to the specified name.true
true
PERSISTENCE:JAVADOC:1385Setjakarta.persistence.metamodel.ManagedType.getDeclaredPluralAttributes
Return all multi-valued attributes (Collection-, Set-, List-, and Map-valued attributes) declared by the managed type. Returns empty set if the managed type has no declared multi-valued attributes.true
true
PERSISTENCE:JAVADOC:1386SetAttributejakarta.persistence.metamodel.ManagedType.getDeclaredSet
( String ,
Class )
Return the Set-valued attribute declared by the managed type that corresponds to the specified name and Java element type.true
true
PERSISTENCE:JAVADOC:1388SetAttributejakarta.persistence.metamodel.ManagedType.getDeclaredSet
( String )
Return the Set-valued attribute declared by the managed type that corresponds to the specified name.true
true
PERSISTENCE:JAVADOC:1390SingularAttributejakarta.persistence.metamodel.ManagedType.getDeclaredSingularAttribute
( String ,
Class )
Return the single-valued attribute declared by the managed type that corresponds to the specified name and Java type.true
true
PERSISTENCE:JAVADOC:1392SingularAttributejakarta.persistence.metamodel.ManagedType.getDeclaredSingularAttribute
( String )
Return the single-valued attribute declared by the managed type that corresponds to the specified name.true
true
PERSISTENCE:JAVADOC:1394Setjakarta.persistence.metamodel.ManagedType.getDeclaredSingularAttributes
Return the single-valued attributes declared by the managed type. Returns empty set if the managed type has no declared single-valued attributes.true
true
PERSISTENCE:JAVADOC:1395ListAttributejakarta.persistence.metamodel.ManagedType.getList
( String ,
Class )
Return the List-valued attribute of the managed type that corresponds to the specified name and Java element type.true
true
PERSISTENCE:JAVADOC:1397ListAttributejakarta.persistence.metamodel.ManagedType.getList
( String )
Return the List-valued attribute of the managed type that corresponds to the specified name.true
true
PERSISTENCE:JAVADOC:1399MapAttributejakarta.persistence.metamodel.ManagedType.getMap
( String ,
Class ,
Class )
Return the Map-valued attribute of the managed type that corresponds to the specified name and Java key and value types.true
true
PERSISTENCE:JAVADOC:1401MapAttributejakarta.persistence.metamodel.ManagedType.getMap
( String )
Return the Map-valued attribute of the managed type that corresponds to the specified name.true
true
PERSISTENCE:JAVADOC:1403Setjakarta.persistence.metamodel.ManagedType.getPluralAttributes
Return all multi-valued attributes (Collection-, Set-, List-, and Map-valued attributes) of the managed type. Returns empty set if the managed type has no multi-valued attributes.true
true
PERSISTENCE:JAVADOC:1404SetAttributejakarta.persistence.metamodel.ManagedType.getSet
( String ,
Class )
Return the Set-valued attribute of the managed type that corresponds to the specified name and Java element type.true
true
PERSISTENCE:JAVADOC:1406SetAttributejakarta.persistence.metamodel.ManagedType.getSet
( String )
Return the Set-valued attribute of the managed type that corresponds to the specified name.true
true
PERSISTENCE:JAVADOC:1408SingularAttributejakarta.persistence.metamodel.ManagedType.getSingularAttribute
( String ,
Class )
Return the single-valued attribute of the managed type that corresponds to the specified name and Java type.true
true
PERSISTENCE:JAVADOC:1410SingularAttributejakarta.persistence.metamodel.ManagedType.getSingularAttribute
( String )
Return the single-valued attribute of the managed type that corresponds to the specified name.true
true
PERSISTENCE:JAVADOC:1412Setjakarta.persistence.metamodel.ManagedType.getSingularAttributes
Return the single-valued attributes of the managed type. Returns empty set if the managed type has no single-valued attributes.true
true
PERSISTENCE:JAVADOC:1415Classjakarta.persistence.metamodel.MapAttribute.getKeyJavaType
Return the Java type of the map key.true
true
PERSISTENCE:JAVADOC:1416Typejakarta.persistence.metamodel.MapAttribute.getKeyType
Return the type representing the key type of the map.true
true
PERSISTENCE:JAVADOC:1433EmbeddableTypejakarta.persistence.metamodel.Metamodel.embeddable
( Class )
Return the metamodel embeddable type representing the embeddable class.true
true
PERSISTENCE:JAVADOC:1435EntityTypejakarta.persistence.metamodel.Metamodel.entity
( Class )
Return the metamodel entity type representing the entity.true
true
PERSISTENCE:JAVADOC:1437Setjakarta.persistence.metamodel.Metamodel.getEmbeddables
Return the metamodel embeddable types. Returns empty set if there are no embeddable types.true
true
PERSISTENCE:JAVADOC:1438Setjakarta.persistence.metamodel.Metamodel.getEntities
Return the metamodel entity types.true
true
PERSISTENCE:JAVADOC:1439Setjakarta.persistence.metamodel.Metamodel.getManagedTypes
Return the metamodel managed types.true
true
PERSISTENCE:JAVADOC:1440ManagedTypejakarta.persistence.metamodel.Metamodel.managedType
( Class )
Return the metamodel managed type representing the entity, mapped superclass, or embeddable class.true
true
PERSISTENCE:JAVADOC:1442CollectionTypejakarta.persistence.metamodel.PluralAttribute.getCollectionType
Return the collection type.true
true
PERSISTENCE:JAVADOC:1443Typejakarta.persistence.metamodel.PluralAttribute.getElementType
Return the type representing the element type of the collection.true
true
PERSISTENCE:JAVADOC:1453CollectionTypejakarta.persistence.metamodel.PluralAttribute.CollectionType.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:1454CollectionType[]jakarta.persistence.metamodel.PluralAttribute.CollectionType.values

true
true
PERSISTENCE:JAVADOC:1457Typejakarta.persistence.metamodel.SingularAttribute.getType
Return the type that represents the type of the attribute.true
true
PERSISTENCE:JAVADOC:1458booleanjakarta.persistence.metamodel.SingularAttribute.isId
Is the attribute an id attribute. This method will return true if the attribute is an attribute that corresponds to a simple id, an embedded id, or an attribute of an id class.true
true
PERSISTENCE:JAVADOC:1459booleanjakarta.persistence.metamodel.SingularAttribute.isOptional
Can the attribute be null.true
true
PERSISTENCE:JAVADOC:1460booleanjakarta.persistence.metamodel.SingularAttribute.isVersion
Is the attribute a version attribute.true
true
PERSISTENCE:JAVADOC:1470Classjakarta.persistence.metamodel.StaticMetamodel.value
Class being modelled by the annotated class.true
true
PERSISTENCE:JAVADOC:1471Classjakarta.persistence.metamodel.Type.getJavaType
Return the represented Java type.true
true
PERSISTENCE:JAVADOC:1472PersistenceTypejakarta.persistence.metamodel.Type.getPersistenceType
Return the persistence type.true
true
PERSISTENCE:JAVADOC:1473PersistenceTypejakarta.persistence.metamodel.Type.PersistenceType.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:1474PersistenceType[]jakarta.persistence.metamodel.Type.PersistenceType.values

true
true
PERSISTENCE:JAVADOC:1477LoadStatejakarta.persistence.spi.LoadState.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:1478LoadState[]jakarta.persistence.spi.LoadState.values

true
true
PERSISTENCE:JAVADOC:1479EntityManagerFactoryjakarta.persistence.spi.PersistenceProvider.createContainerEntityManagerFactory
( PersistenceUnitInfo ,
Map )
Called by the container when an EntityManagerFactory is to be created.true
true
PERSISTENCE:JAVADOC:1480EntityManagerFactoryjakarta.persistence.spi.PersistenceProvider.createEntityManagerFactory
( String ,
Map )
Called by Persistence class when an EntityManagerFactory is to be created.true
true
PERSISTENCE:JAVADOC:1481ProviderUtiljakarta.persistence.spi.PersistenceProvider.getProviderUtil
Return the utility interface implemented by the persistence provider.true
true
PERSISTENCE:JAVADOC:1482voidjakarta.persistence.spi.PersistenceProviderResolver.clearCachedProviders
Clear cache of providers.true
false
PERSISTENCE:JAVADOC:1483Listjakarta.persistence.spi.PersistenceProviderResolver.getPersistenceProviders
Returns a list of the PersistenceProvider implementations available in the runtime environment.true
false
PERSISTENCE:JAVADOC:1484PersistenceProviderResolverjakarta.persistence.spi.PersistenceProviderResolverHolder.getPersistenceProviderResolver
Returns the current persistence provider resolver.true
false
PERSISTENCE:JAVADOC:1485PersistenceProviderResolverHolderjakarta.persistence.spi.PersistenceProviderResolverHolder.PersistenceProviderResolverHolder

true
false
PERSISTENCE:JAVADOC:1486voidjakarta.persistence.spi.PersistenceProviderResolverHolder.setPersistenceProviderResolver
( PersistenceProviderResolver )
Defines the persistence provider resolver used.true
false
PERSISTENCE:JAVADOC:1488booleanjakarta.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 exclude-unlisted-classes element in the persistence.xml file.true
true
PERSISTENCE:JAVADOC:1489ClassLoaderjakarta.persistence.spi.PersistenceUnitInfo.getClassLoader
Returns ClassLoader that the provider may use to load any classes, resources, or open URLs.true
true
PERSISTENCE:JAVADOC:1490Listjakarta.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 jar-file 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:1491DataSourcejakarta.persistence.spi.PersistenceUnitInfo.getJtaDataSource
Returns the JTA-enabled data source to be used by the persistence provider. The data source corresponds to the jta-data-source element in the persistence.xml file or is provided at deployment or by the container.true
true
PERSISTENCE:JAVADOC:1492Listjakarta.persistence.spi.PersistenceUnitInfo.getManagedClassNames
Returns the list of the names of the classes that the persistence provider must add to its set of managed classes. Each name corresponds to a named class element in the persistence.xml file.true
true
PERSISTENCE:JAVADOC:1493Listjakarta.persistence.spi.PersistenceUnitInfo.getMappingFileNames
Returns the list of the names of the mapping files 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. Each mapping file name corresponds to a mapping-file element in the persistence.xml file.true
true
PERSISTENCE:JAVADOC:1494ClassLoaderjakarta.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:1495DataSourcejakarta.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 non-jta-data-source element in the persistence.xml file or provided at deployment or by the container.true
true
PERSISTENCE:JAVADOC:1496Stringjakarta.persistence.spi.PersistenceUnitInfo.getPersistenceProviderClassName
Returns the fully qualified name of the persistence provider implementation class. Corresponds to the provider element in the persistence.xml file.true
true
PERSISTENCE:JAVADOC:1497Stringjakarta.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:1498URLjakarta.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:1499Stringjakarta.persistence.spi.PersistenceUnitInfo.getPersistenceXMLSchemaVersion
Returns the schema version of the persistence.xml file.true
true
PERSISTENCE:JAVADOC:1500Propertiesjakarta.persistence.spi.PersistenceUnitInfo.getProperties
Returns a properties object. Each property corresponds to a property element in the persistence.xml file or to a property set by the container.true
true
PERSISTENCE:JAVADOC:1501SharedCacheModejakarta.persistence.spi.PersistenceUnitInfo.getSharedCacheMode
Returns the specification of how the provider must use a second-level cache for the persistence unit. The result of this method corresponds to the shared-cache-mode element in the persistence.xml file.true
true
PERSISTENCE:JAVADOC:1502PersistenceUnitTransactionTypejakarta.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:1503ValidationModejakarta.persistence.spi.PersistenceUnitInfo.getValidationMode
Returns the validation mode to be used by the persistence provider for the persistence unit. The validation mode corresponds to the validation-mode element in the persistence.xml file.true
true
PERSISTENCE:JAVADOC:1504PersistenceUnitTransactionTypejakarta.persistence.spi.PersistenceUnitTransactionType.valueOf
( String )

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

true
true
PERSISTENCE:JAVADOC:1506LoadStatejakarta.persistence.spi.ProviderUtil.isLoaded
( Object )
If the provider determines that the entity has been provided by itself and that the state of all attributes for which FetchType.EAGER has been specified have been loaded, this method returns LoadState.LOADED. If the provider determines that the entity has been provided by itself and that not all attributes with FetchType.EAGER have been loaded, this method returns LoadState.NOT_LOADED. If the provider cannot determine if the entity has been provided by itself, this method returns LoadState.UNKNOWN. The provider's implementation of this method must not obtain a reference to any attribute value, as this could trigger the loading of entity state if the entity has been provided by a different provider.true
true
PERSISTENCE:JAVADOC:1507LoadStatejakarta.persistence.spi.ProviderUtil.isLoadedWithoutReference
( Object ,
String )
If the provider determines that the entity has been provided by itself and that the state of the specified attribute has been loaded, this method returns LoadState.LOADED. If the provider determines that the entity has been provided by itself and that either entity attributes with FetchType.EAGER have not been loaded or that the state of the specified attribute has not been loaded, this methods returns LoadState.NOT_LOADED. If a provider cannot determine the load state, this method returns LoadState.UNKNOWN. The provider's implementation of this method must not obtain a reference to an attribute value, as this could trigger the loading of entity state if the entity has been provided by a different provider.true
false
PERSISTENCE:JAVADOC:1508LoadStatejakarta.persistence.spi.ProviderUtil.isLoadedWithReference
( Object ,
String )
If the provider determines that the entity has been provided by itself and that the state of the specified attribute has been loaded, this method returns LoadState.LOADED. If a provider determines that the entity has been provided by itself and that either the entity attributes with FetchType.EAGER have not been loaded or that the state of the specified attribute has not been loaded, this method returns return LoadState.NOT_LOADED. If the provider cannot determine the load state, this method returns LoadState.UNKNOWN. The provider's implementation of this method is permitted to obtain a reference to the attribute value. (This access is safe because providers which might trigger the loading of the attribute state will have already been determined by isLoadedWithoutReference. )true
false
PERSISTENCE:JAVADOC:1509Objectjakarta.persistence.Cache.unwrap
( Class )
Return an object of the specified type to allow access to the provider-specific API. If the provider's Cache implementation does not support the specified class, the PersistenceException is thrown.true
false
PERSISTENCE:JAVADOC:1511Classjakarta.persistence.ColumnResult.type
(Optional) The Java type to which the column type is to be mapped. If the type element is not specified, the default JDBC type mapping for the column will be used.true
true
PERSISTENCE:JAVADOC:1512ColumnResult[]jakarta.persistence.ConstructorResult.columns
(Required) The mapping of columns in the SELECT list to the arguments of the intended constructor, in order.true
true
PERSISTENCE:JAVADOC:1513Classjakarta.persistence.ConstructorResult.targetClass
(Required) The class whose constructor is to be invoked.true
true
PERSISTENCE:JAVADOC:1514StoredProcedureQueryjakarta.persistence.EntityManager.createNamedStoredProcedureQuery
( String )
Create an instance of StoredProcedureQuery for executing a stored procedure in the database. Parameters must be registered before the stored procedure can be executed. If the stored procedure returns one or more result sets, any result set will be returned as a list of type Object[].true
true
PERSISTENCE:JAVADOC:1516Queryjakarta.persistence.EntityManager.createQuery
( CriteriaUpdate )
Create an instance of Query for executing a criteria update query.true
true
PERSISTENCE:JAVADOC:1518Queryjakarta.persistence.EntityManager.createQuery
( CriteriaDelete )
Create an instance of Query for executing a criteria delete query.true
true
PERSISTENCE:JAVADOC:1520StoredProcedureQueryjakarta.persistence.EntityManager.createStoredProcedureQuery
( String )
Create an instance of StoredProcedureQuery for executing a stored procedure in the database. Parameters must be registered before the stored procedure can be executed. If the stored procedure returns one or more result sets, any result set will be returned as a list of type Object[].true
true
PERSISTENCE:JAVADOC:1522StoredProcedureQueryjakarta.persistence.EntityManager.createStoredProcedureQuery
( String ,
Class[] )
Create an instance of StoredProcedureQuery for executing a stored procedure in the database. Parameters must be registered before the stored procedure can be executed. The resultClass arguments must be specified in the order in which the result sets will be returned by the stored procedure invocation.true
true
PERSISTENCE:JAVADOC:1524StoredProcedureQueryjakarta.persistence.EntityManager.createStoredProcedureQuery
( String ,
String[] )
Create an instance of StoredProcedureQuery for executing a stored procedure in the database. Parameters must be registered before the stored procedure can be executed. The resultSetMapping arguments must be specified in the order in which the result sets will be returned by the stored procedure invocation.true
true
PERSISTENCE:JAVADOC:1526booleanjakarta.persistence.EntityManager.isJoinedToTransaction
Determine whether the entity manager is joined to the current transaction. Returns false if the entity manager is not joined to the current transaction or if no transaction is activetrue
true
PERSISTENCE:JAVADOC:1527voidjakarta.persistence.EntityManagerFactory.addNamedQuery
( String ,
Query )
Define the query, typed query, or stored procedure query as a named query such that future query objects can be created from it using the createNamedQuery or createNamedStoredProcedureQuery method. Any configuration of the query object (except for actual parameter binding) in effect when the named query is added is retained as part of the named query definition. This includes configuration information such as max results, hints, flush mode, lock mode, result set mapping information, and information about stored procedure parameters. When the query is executed, information that can be set by means of the query APIs can be overridden. Information that is overridden does not affect the named query as registered with the entity manager factory, and thus does not affect subsequent query objects created from it by means of the createNamedQuery or createNamedStoredProcedureQuery method. If a named query of the same name has been previously defined, either statically via metadata or via this method, that query definition is replaced.true
true
PERSISTENCE:JAVADOC:1528Objectjakarta.persistence.EntityManagerFactory.unwrap
( Class )
Return an object of the specified type to allow access to the provider-specific API. If the provider's EntityManagerFactory implementation does not support the specified class, the PersistenceException is thrown.true
false
PERSISTENCE:JAVADOC:1530NamedStoredProcedureQuery[]jakarta.persistence.NamedStoredProcedureQueries.value
(Required) Array of NamedStoredProcedureQuery annotations.true
true
PERSISTENCE:JAVADOC:1531QueryHint[]jakarta.persistence.NamedStoredProcedureQuery.hints
Query properties and hints. (May include vendor-specific query hints.)true
false
PERSISTENCE:JAVADOC:1532Stringjakarta.persistence.NamedStoredProcedureQuery.name
The name used to refer to the query with the EntityManager methods that create stored procedure query objects.true
true
PERSISTENCE:JAVADOC:1533StoredProcedureParameter[]jakarta.persistence.NamedStoredProcedureQuery.parameters
Information about all parameters of the stored procedure. All parameters must be specified in the order in which they occur in the parameter list of the stored procedure.true
true
PERSISTENCE:JAVADOC:1534Stringjakarta.persistence.NamedStoredProcedureQuery.procedureName
The name of the stored procedure in the database.true
true
PERSISTENCE:JAVADOC:1535Class[]jakarta.persistence.NamedStoredProcedureQuery.resultClasses
The class or classes that are used to map the results.true
true
PERSISTENCE:JAVADOC:1537ParameterModejakarta.persistence.ParameterMode.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:1538ParameterMode[]jakarta.persistence.ParameterMode.values

true
true
PERSISTENCE:JAVADOC:1539SynchronizationTypejakarta.persistence.PersistenceContext.synchronization
(Optional) 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 EntityManager#joinTransaction joinTransaction method.true
true
PERSISTENCE:JAVADOC:1540ConstructorResult[]jakarta.persistence.SqlResultSetMapping.classes
Specifies the result set mapping to constructors.true
true
PERSISTENCE:JAVADOC:1541ParameterModejakarta.persistence.StoredProcedureParameter.mode
Specifies whether the parameter is an IN, INOUT, OUT, or REF_CURSOR parameter. REF_CURSOR parameters are used by some databases to return result sets from a stored procedure.true
true
PERSISTENCE:JAVADOC:1542Stringjakarta.persistence.StoredProcedureParameter.name
The name of the parameter as defined by the stored procedure in the database. If a name is not specified, it is assumed that the stored procedure uses positional parameters.true
false
PERSISTENCE:JAVADOC:1543Classjakarta.persistence.StoredProcedureParameter.type
JDBC type of the paramter.true
true
PERSISTENCE:JAVADOC:1544booleanjakarta.persistence.StoredProcedureQuery.execute
Return true if the first result corresponds to a result set, and false if it is an update count or if there are no results other than through INOUT and OUT parameters, if any.true
true
PERSISTENCE:JAVADOC:1547Objectjakarta.persistence.StoredProcedureQuery.getOutputParameterValue
( int )
Retrieve a value passed back from the procedure through an INOUT or OUT parameter. For portability, all results corresponding to result sets and update counts must be retrieved before the values of output parameters.true
true
PERSISTENCE:JAVADOC:1549Objectjakarta.persistence.StoredProcedureQuery.getOutputParameterValue
( String )
Retrieve a value passed back from the procedure through an INOUT or OUT parameter. For portability, all results corresponding to result sets and update counts must be retrieved before the values of output parameters.true
false
PERSISTENCE:JAVADOC:1551intjakarta.persistence.StoredProcedureQuery.getUpdateCount
Return the update count or -1 if there is no pending result or if the next result is not an update count.true
true
PERSISTENCE:JAVADOC:1554booleanjakarta.persistence.StoredProcedureQuery.hasMoreResults
Return true if the next result corresponds to a result set, and false if it is an update count or if there are no results other than through INOUT and OUT parameters, if any.true
true
PERSISTENCE:JAVADOC:1557StoredProcedureQueryjakarta.persistence.StoredProcedureQuery.registerStoredProcedureParameter
( int ,
Class ,
ParameterMode )
Register a positional parameter. All parameters must be registered.true
true
PERSISTENCE:JAVADOC:1558StoredProcedureQueryjakarta.persistence.StoredProcedureQuery.registerStoredProcedureParameter
( String ,
Class ,
ParameterMode )
Register a named parameter.true
true
PERSISTENCE:JAVADOC:1559StoredProcedureQueryjakarta.persistence.StoredProcedureQuery.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:1560StoredProcedureQueryjakarta.persistence.StoredProcedureQuery.setHint
( String ,
Object )
Set a query property or hint. The hints elements may be used to specify query properties and hints. Properties defined by this specification must be observed by the provider. Vendor-specific hints that are not recognized by a provider must be silently ignored. Portable applications should not rely on the standard timeout hint. Depending on the database in use, this hint may or may not be observed.true
false
PERSISTENCE:JAVADOC:1562StoredProcedureQueryjakarta.persistence.StoredProcedureQuery.setParameter
( Parameter ,
Object )
Bind the value of a Parameter object.true
true
PERSISTENCE:JAVADOC:1564StoredProcedureQueryjakarta.persistence.StoredProcedureQuery.setParameter
( Parameter ,
Calendar ,
TemporalType )
Bind an instance of java.util.Calendar to a Parameter object.true
true
PERSISTENCE:JAVADOC:1566StoredProcedureQueryjakarta.persistence.StoredProcedureQuery.setParameter
( Parameter ,
Date ,
TemporalType )
Bind an instance of java.util.Date to a Parameter object.true
true
PERSISTENCE:JAVADOC:1568StoredProcedureQueryjakarta.persistence.StoredProcedureQuery.setParameter
( String ,
Object )
Bind an argument value to a named parameter.true
false
PERSISTENCE:JAVADOC:1570StoredProcedureQueryjakarta.persistence.StoredProcedureQuery.setParameter
( String ,
Calendar ,
TemporalType )
Bind an instance of java.util.Calendar to a named parameter.true
false
PERSISTENCE:JAVADOC:1572StoredProcedureQueryjakarta.persistence.StoredProcedureQuery.setParameter
( String ,
Date ,
TemporalType )
Bind an instance of java.util.Date to a named parameter.true
false
PERSISTENCE:JAVADOC:1574StoredProcedureQueryjakarta.persistence.StoredProcedureQuery.setParameter
( int ,
Object )
Bind an argument value to a positional parameter.true
true
PERSISTENCE:JAVADOC:1576StoredProcedureQueryjakarta.persistence.StoredProcedureQuery.setParameter
( int ,
Calendar ,
TemporalType )
Bind an instance of java.util.Calendar to a positional parameter.true
true
PERSISTENCE:JAVADOC:1578StoredProcedureQueryjakarta.persistence.StoredProcedureQuery.setParameter
( int ,
Date ,
TemporalType )
Bind an instance of java.util.Date to a positional parameter.true
true
PERSISTENCE:JAVADOC:1660SynchronizationTypejakarta.persistence.SynchronizationType.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:1661SynchronizationType[]jakarta.persistence.SynchronizationType.values

true
true
PERSISTENCE:JAVADOC:1668CollectionJoinjakarta.persistence.criteria.CollectionJoin.on
( Expression )
Modify the join to restrict the result according to the specified ON condition and return the join object. Replaces the previous ON condition, if any.true
true
PERSISTENCE:JAVADOC:1669CollectionJoinjakarta.persistence.criteria.CollectionJoin.on
( Predicate[] )
Modify the join to restrict the result according to the specified ON condition and return the join object. Replaces the previous ON condition, if any.true
true
PERSISTENCE:JAVADOC:1676CriteriaDeletejakarta.persistence.criteria.CriteriaBuilder.createCriteriaDelete
( Class )
Create a CriteriaDelete query object to perform a bulk delete operation.true
true
PERSISTENCE:JAVADOC:1677CriteriaUpdatejakarta.persistence.criteria.CriteriaBuilder.createCriteriaUpdate
( Class )
Create a CriteriaUpdate query object to perform a bulk update operation.true
true
PERSISTENCE:JAVADOC:1678Joinjakarta.persistence.criteria.CriteriaBuilder.treat
( Join ,
Class )
Downcast Join object to the specified type.true
true
PERSISTENCE:JAVADOC:1679CollectionJoinjakarta.persistence.criteria.CriteriaBuilder.treat
( CollectionJoin ,
Class )
Downcast CollectionJoin object to the specified type.true
true
PERSISTENCE:JAVADOC:1680SetJoinjakarta.persistence.criteria.CriteriaBuilder.treat
( SetJoin ,
Class )
Downcast SetJoin object to the specified type.true
true
PERSISTENCE:JAVADOC:1681ListJoinjakarta.persistence.criteria.CriteriaBuilder.treat
( ListJoin ,
Class )
Downcast ListJoin object to the specified type.true
true
PERSISTENCE:JAVADOC:1682MapJoinjakarta.persistence.criteria.CriteriaBuilder.treat
( MapJoin ,
Class )
Downcast MapJoin object to the specified type.true
true
PERSISTENCE:JAVADOC:1683Pathjakarta.persistence.criteria.CriteriaBuilder.treat
( Path ,
Class )
Downcast Path object to the specified type.true
true
PERSISTENCE:JAVADOC:1684Rootjakarta.persistence.criteria.CriteriaBuilder.treat
( Root ,
Class )
Downcast Root object to the specified type.true
true
PERSISTENCE:JAVADOC:1685Rootjakarta.persistence.criteria.CriteriaDelete.from
( Class )
Create and add a query root corresponding to the entity that is the target of the delete. A CriteriaDelete object has a single root, the entity that is being deleted.true
true
PERSISTENCE:JAVADOC:1686Rootjakarta.persistence.criteria.CriteriaDelete.from
( EntityType )
Create and add a query root corresponding to the entity that is the target of the delete. A CriteriaDelete object has a single root, the entity that is being deleted.true
true
PERSISTENCE:JAVADOC:1687Rootjakarta.persistence.criteria.CriteriaDelete.getRoot
Return the query root.true
true
PERSISTENCE:JAVADOC:1688CriteriaDeletejakarta.persistence.criteria.CriteriaDelete.where
( Expression )
Modify the delete query to restrict the target of the deletion according to the specified boolean expression. Replaces the previously added restriction(s), if any.true
true
PERSISTENCE:JAVADOC:1689CriteriaDeletejakarta.persistence.criteria.CriteriaDelete.where
( Predicate[] )
Modify the delete query to restrict the target of the deletion according to the conjunction of the specified restriction predicates. Replaces the previously added restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed.true
true
PERSISTENCE:JAVADOC:1696Rootjakarta.persistence.criteria.CriteriaUpdate.from
( Class )
Create and add a query root corresponding to the entity that is the target of the update. A CriteriaUpdate object has a single root, the entity that is being updated.true
true
PERSISTENCE:JAVADOC:1697Rootjakarta.persistence.criteria.CriteriaUpdate.from
( EntityType )
Create and add a query root corresponding to the entity that is the target of the update. A CriteriaUpdate object has a single root, the entity that is being updated.true
true
PERSISTENCE:JAVADOC:1698Rootjakarta.persistence.criteria.CriteriaUpdate.getRoot
Return the query root.true
true
PERSISTENCE:JAVADOC:1699CriteriaUpdatejakarta.persistence.criteria.CriteriaUpdate.set
( SingularAttribute ,
Object )
Update the value of the specified attribute.true
true
PERSISTENCE:JAVADOC:1700CriteriaUpdatejakarta.persistence.criteria.CriteriaUpdate.set
( SingularAttribute ,
Expression )
Update the value of the specified attribute.true
true
PERSISTENCE:JAVADOC:1701CriteriaUpdatejakarta.persistence.criteria.CriteriaUpdate.set
( Path ,
Object )
Update the value of the specified attribute.true
true
PERSISTENCE:JAVADOC:1702CriteriaUpdatejakarta.persistence.criteria.CriteriaUpdate.set
( Path ,
Expression )
Update the value of the specified attribute.true
true
PERSISTENCE:JAVADOC:1703CriteriaUpdatejakarta.persistence.criteria.CriteriaUpdate.set
( String ,
Object )
Update the value of the specified attribute.true
true
PERSISTENCE:JAVADOC:1704CriteriaUpdatejakarta.persistence.criteria.CriteriaUpdate.where
( Expression )
Modify the update query to restrict the target of the update according to the specified boolean expression. Replaces the previously added restriction(s), if any.true
true
PERSISTENCE:JAVADOC:1705CriteriaUpdatejakarta.persistence.criteria.CriteriaUpdate.where
( Predicate[] )
Modify the update query to restrict the target of the update according to the conjunction of the specified restriction predicates. Replaces the previously added restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed.true
true
PERSISTENCE:JAVADOC:1715Predicatejakarta.persistence.criteria.Join.getOn
Return the predicate that corresponds to the ON restriction(s) on the join, or null if no ON condition has been specified.true
true
PERSISTENCE:JAVADOC:1716Joinjakarta.persistence.criteria.Join.on
( Expression )
Modify the join to restrict the result according to the specified ON condition and return the join object. Replaces the previous ON condition, if any.true
true
PERSISTENCE:JAVADOC:1717Joinjakarta.persistence.criteria.Join.on
( Predicate[] )
Modify the join to restrict the result according to the specified ON condition and return the join object. Replaces the previous ON condition, if any.true
true
PERSISTENCE:JAVADOC:1718ListJoinjakarta.persistence.criteria.ListJoin.on
( Expression )
Modify the join to restrict the result according to the specified ON condition and return the join object. Replaces the previous ON condition, if any.true
true
PERSISTENCE:JAVADOC:1719ListJoinjakarta.persistence.criteria.ListJoin.on
( Predicate[] )
Modify the join to restrict the result according to the specified ON condition and return the join object. Replaces the previous ON condition, if any.true
true
PERSISTENCE:JAVADOC:1720MapJoinjakarta.persistence.criteria.MapJoin.on
( Expression )
Modify the join to restrict the result according to the specified ON condition and return the join object. Replaces the previous ON condition, if any.true
true
PERSISTENCE:JAVADOC:1721MapJoinjakarta.persistence.criteria.MapJoin.on
( Predicate[] )
Modify the join to restrict the result according to the specified ON condition and return the join object. Replaces the previous ON condition, if any.true
true
PERSISTENCE:JAVADOC:1725SetJoinjakarta.persistence.criteria.SetJoin.on
( Expression )
Modify the join to restrict the result according to the specified ON condition and return the join object. Replaces the previous ON condition, if any.true
true
PERSISTENCE:JAVADOC:1726SetJoinjakarta.persistence.criteria.SetJoin.on
( Predicate[] )
Modify the join to restrict the result according to the specified ON condition and return the join object. Replaces the previous ON condition, if any.true
true
PERSISTENCE:JAVADOC:3310Objectjakarta.persistence.AttributeConverter.convertToDatabaseColumn
( Object )
Converts the value stored in the entity attribute into the data representation to be stored in the database.true
true
PERSISTENCE:JAVADOC:3311Objectjakarta.persistence.AttributeConverter.convertToEntityAttribute
( Object )
Converts the data stored in the database column into the value to be stored in the entity attribute. Note that it is the responsibility of the converter writer to specify the correct dbData type for the corresponding column for use by the JDBC driver: i.e., persistence providers are not expected to do such type conversion.true
true
PERSISTENCE:JAVADOC:3312Stringjakarta.persistence.Convert.attributeName
The attributeName element must be specified unless the Convert annotation is on an attribute of basic type or on an element collection of basic type. In these cases, the attributeName element must not be specified.true
true
PERSISTENCE:JAVADOC:3313Classjakarta.persistence.Convert.converter
Specifies the converter to be applied. A value for this element must be specified if multiple converters would otherwise apply.true
true
PERSISTENCE:JAVADOC:3314booleanjakarta.persistence.Convert.disableConversion
Used to disable an auto-apply or inherited converter. If disableConversion is true, the converter element should not be specified.true
true
PERSISTENCE:JAVADOC:3315booleanjakarta.persistence.Converter.autoApply

true
true
PERSISTENCE:JAVADOC:3316Convert[]jakarta.persistence.Converts.value
The Convert mappings that are to be applied.true
true
PERSISTENCE:JAVADOC:3317String[]jakarta.persistence.NamedStoredProcedureQuery.resultSetMappings
The names of one or more result set mappings, as defined in metadata.true
true
PERSISTENCE:JAVADOC:3318EntityManagerjakarta.persistence.EntityManagerFactory.createEntityManager
( SynchronizationType ,
Map )
Create a new JTA application-managed EntityManager with the specified synchronization type and 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:3321Index[]jakarta.persistence.CollectionTable.indexes
(Optional) Indexes for the table. These are only used if table generation is in effect.true
true
PERSISTENCE:JAVADOC:3322EntityManagerjakarta.persistence.EntityManagerFactory.createEntityManager
( SynchronizationType )
Create a new JTA application-managed EntityManager with the specified synchronization type. 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:3325Stringjakarta.persistence.ForeignKey.foreignKeyDefinition
(Optional) The foreign key constraint definition.true
true
PERSISTENCE:JAVADOC:3326Stringjakarta.persistence.ForeignKey.name
(Optional) The name of the foreign key constraint. If this is not specified, it defaults to a provider-generated name.true
true
PERSISTENCE:JAVADOC:3327Stringjakarta.persistence.Index.columnList
(Required) The names of the columns to be included in the index, in order.true
true
PERSISTENCE:JAVADOC:3328Stringjakarta.persistence.Index.name
(Optional) The name of the index; defaults to a provider-generated name.true
true
PERSISTENCE:JAVADOC:3329booleanjakarta.persistence.Index.unique
(Optional) Whether the index is unique.true
true
PERSISTENCE:JAVADOC:3330ForeignKeyjakarta.persistence.JoinColumn.foreignKey
(Optional) Used to specify or control the generation of a foreign key constraint when table generation is in effect. If this element is not specified, the persistence provider's default foreign key strategy will apply.true
true
PERSISTENCE:JAVADOC:3331ForeignKeyjakarta.persistence.JoinColumns.foreignKey
(Optional) Used to specify or control the generation of a foreign key constraint when table generation is in effect. If both this element and the foreignKey element of any of the JoinColumn elements are specified, the behavior is undefined. If no foreign key annotation element is specified in either location, the persistence provider's default foreign key strategy will apply.true
true
PERSISTENCE:JAVADOC:3332Index[]jakarta.persistence.JoinTable.indexes
(Optional) Indexes for the table. These are only used if table generation is in effect.true
true
PERSISTENCE:JAVADOC:3333ForeignKeyjakarta.persistence.MapKeyJoinColumn.foreignKey
(Optional) Used to specify or control the generation of a foreign key constraint when table generation is in effect. If this element is not specified, the persistence provider's default foreign key strategy will apply.true
true
PERSISTENCE:JAVADOC:3334ForeignKeyjakarta.persistence.MapKeyJoinColumns.foreignKey
(Optional) Used to specify or control the generation of a foreign key constraint when table generation is in effect. If both this element and the foreignKey element of any of the MapKeyJoinColumn elements are specified, the behavior is undefined. If no foreign key annotation element is specified in either location, the persistence provider's default foreign key strategy will apply.true
true
PERSISTENCE:JAVADOC:3335voidjakarta.persistence.Persistence.generateSchema
( String ,
Map )
Create database schemas and/or tables and/or create DDL scripts as determined by the supplied properties. Called when schema generation is to occur as a separate phase from creation of the entity manager factory.true
true
PERSISTENCE:JAVADOC:3337ForeignKeyjakarta.persistence.PrimaryKeyJoinColumn.foreignKey
(Optional) Used to specify or control the generation of a foreign key constraint for the primary key join column when table generation is in effect. If this element is not specified, the persistence provider's default foreign key strategy will apply.true
true
PERSISTENCE:JAVADOC:3338ForeignKeyjakarta.persistence.PrimaryKeyJoinColumns.foreignKey
(Optional) Used to specify or control the generation of a foreign key constraint when table generation is in effect. If both this element and the foreignKey element of any of the PrimaryKeyJoinColumn elements are specified, the behavior is undefined. If no foreign key annotation element is specified in either location, the persistence provider's default foreign key strategy will apply.true
true
PERSISTENCE:JAVADOC:3339Index[]jakarta.persistence.SecondaryTable.indexes
(Optional) Indexes for the table. These are only used if table generation is in effect.true
true
PERSISTENCE:JAVADOC:3340Index[]jakarta.persistence.Table.indexes
(Optional) Indexes for the table. These are only used if table generation is in effect. Note that it is not necessary to specify an index for a primary key, as the primary key index will be created automatically.true
true
PERSISTENCE:JAVADOC:3341Index[]jakarta.persistence.TableGenerator.indexes
(Optional) Indexes for the table. These are only used if table generation is in effect. Note that it is not necessary to specify an index for a primary key, as the primary key index will be created automatically.true
true
PERSISTENCE:JAVADOC:3344Predicatejakarta.persistence.criteria.CommonAbstractCriteria.getRestriction
Return the predicate that corresponds to the where clause restriction(s), or null if no restrictions have been specified.true
false
PERSISTENCE:JAVADOC:3345Subqueryjakarta.persistence.criteria.CommonAbstractCriteria.subquery
( Class )
Create a subquery of the query.true
false
PERSISTENCE:JAVADOC:3356CommonAbstractCriteriajakarta.persistence.criteria.Subquery.getContainingQuery
Return the query of which this is a subquery. This may be a CriteriaQuery, CriteriaUpdate, CriteriaDelete, or a Subquery.true
true
PERSISTENCE:JAVADOC:3357voidjakarta.persistence.spi.PersistenceProvider.generateSchema
( PersistenceUnitInfo ,
Map )
Create database schemas and/or tables and/or create DDL scripts as determined by the supplied properties. Called by the container when schema generation is to occur as a separate phase from creation of the entity manager factory.true
false
PERSISTENCE:JAVADOC:3360Stringjakarta.persistence.AttributeNode.getAttributeName
Return the name of the attribute corresponding to the attribute node.true
true
PERSISTENCE:JAVADOC:3362voidjakarta.persistence.EntityGraph.addAttributeNodes
( String[] )
Add one or more attribute nodes to the entity graph.true
true
PERSISTENCE:JAVADOC:3365voidjakarta.persistence.EntityGraph.addAttributeNodes
( Attribute[] )
Add one or more attribute nodes to the entity graph.true
true
PERSISTENCE:JAVADOC:3367Subgraphjakarta.persistence.EntityGraph.addKeySubgraph
( Attribute )
Add a node to the graph that corresponds to a map key that is a managed type. This allows for construction of multi-node entity graphs that include related managed types.true
true
PERSISTENCE:JAVADOC:3370Subgraphjakarta.persistence.EntityGraph.addKeySubgraph
( Attribute ,
Class )
Add a node to the graph that corresponds to a map key that is a managed type with inheritance. This allows for construction of multi-node entity graphs that include related managed types. Subclass subgraphs will include the specified attributes of superclass subgraphs.true
true
PERSISTENCE:JAVADOC:3373Subgraphjakarta.persistence.EntityGraph.addKeySubgraph
( String )
Add a node to the graph that corresponds to a map key that is a managed type. This allows for construction of multi-node entity graphs that include related managed types.true
true
PERSISTENCE:JAVADOC:3377Subgraphjakarta.persistence.EntityGraph.addKeySubgraph
( String ,
Class )
Add a node to the graph that corresponds to a map key that is a managed type with inheritance. This allows for construction of multi-node entity graphs that include related managed types. Subclass subgraphs will automatically include the specified attributes of superclass subgraphstrue
true
PERSISTENCE:JAVADOC:3381Subgraphjakarta.persistence.EntityGraph.addSubclassSubgraph
( Class )
Add additional attributes to this entity graph that correspond to attributes of subclasses of this EntityGraph's entity type. Subclass subgraphs will automatically include the specified attributes of superclass subgraphs.true
true
PERSISTENCE:JAVADOC:3384Subgraphjakarta.persistence.EntityGraph.addSubgraph
( Attribute )
Add a node to the graph that corresponds to a managed type. This allows for construction of multi-node entity graphs that include related managed types.true
true
PERSISTENCE:JAVADOC:3387Subgraphjakarta.persistence.EntityGraph.addSubgraph
( Attribute ,
Class )
Add a node to the graph that corresponds to a managed type with inheritance. This allows for multiple subclass subgraphs to be defined for this node of the entity graph. Subclass subgraphs will automatically include the specified attributes of superclass subgraphs.true
true
PERSISTENCE:JAVADOC:3390Subgraphjakarta.persistence.EntityGraph.addSubgraph
( String )
Add a node to the graph that corresponds to a managed type. This allows for construction of multi-node entity graphs that include related managed types.true
true
PERSISTENCE:JAVADOC:3394Subgraphjakarta.persistence.EntityGraph.addSubgraph
( String ,
Class )
Add a node to the graph that corresponds to a managed type with inheritance. This allows for multiple subclass subgraphs to be defined for this node of the entity graph. Subclass subgraphs will automatically include the specified attributes of superclass subgraphs.true
true
PERSISTENCE:JAVADOC:3398Listjakarta.persistence.EntityGraph.getAttributeNodes
Return the attribute nodes of this entity that are included in the entity graph.true
true
PERSISTENCE:JAVADOC:3399Stringjakarta.persistence.EntityGraph.getName
Return the name of a named EntityGraph (an entity graph defined by means of the NamedEntityGraph annotation, XML descriptor element, or added by means of the addNamedEntityGraph method. Returns null if the EntityGraph is not a named EntityGraph.true
true
PERSISTENCE:JAVADOC:3402EntityGraphjakarta.persistence.EntityManager.createEntityGraph
( Class )
Return a mutable EntityGraph that can be used to dynamically create an EntityGraph.true
true
PERSISTENCE:JAVADOC:3403EntityGraphjakarta.persistence.EntityManager.createEntityGraph
( String )
Return a mutable copy of the named EntityGraph. If there is no entity graph with the specified name, null is returned.true
true
PERSISTENCE:JAVADOC:3404EntityGraphjakarta.persistence.EntityManager.getEntityGraph
( String )
Return a named EntityGraph. The returned EntityGraph should be considered immutable.true
true
PERSISTENCE:JAVADOC:3406Listjakarta.persistence.EntityManager.getEntityGraphs
( Class )
Return all named EntityGraphs that have been defined for the provided class type.true
true
PERSISTENCE:JAVADOC:3411voidjakarta.persistence.EntityManagerFactory.addNamedEntityGraph
( String ,
EntityGraph )
Add a named copy of the EntityGraph to the EntityManagerFactory. If an entity graph with the same name already exists, it is replaced.true
true
PERSISTENCE:JAVADOC:3412Stringjakarta.persistence.NamedAttributeNode.keySubgraph
(Optional) If the attribute references a Map type, this element can be used to specify a subgraph for the Key in the case of an Entity key type. A keySubgraph can not be specified without the Map attribute also being specified. If the target type has inheritance, multiple subgraphs can be specified. These additional subgraphs are intended to add subclass-specific attributes. Superclass subgraph entries will be merged into subclass subgraphs. The value of this element is the name of the key subgraph as specified by the name element of the corresponding NamedSubgraph element. If multiple key subgraphs are specified due to inheritance, they are referenced by this name.true
true
PERSISTENCE:JAVADOC:3413Stringjakarta.persistence.NamedAttributeNode.subgraph
(Optional) If the attribute references a managed type that has its own AttributeNodes, this element is used to refer to that NamedSubgraph definition. If the target type has inheritance, multiple subgraphs can be specified. These additional subgraphs are intended to add subclass-specific attributes. Superclass subgraph entries will be merged into subclass subgraphs. The value of this element is the name of the subgraph as specified by the name element of the corresponding NamedSubgraph element. If multiple subgraphs are specified due to inheritance, they are referenced by this name.true
true
PERSISTENCE:JAVADOC:3414Stringjakarta.persistence.NamedAttributeNode.value
(Required) The name of the attribute that must be included in the graph.true
true
PERSISTENCE:JAVADOC:3415NamedAttributeNode[]jakarta.persistence.NamedEntityGraph.attributeNodes
(Optional) A list of attributes of the entity that are included in this graph.true
true
PERSISTENCE:JAVADOC:3416booleanjakarta.persistence.NamedEntityGraph.includeAllAttributes
(Optional) Includes all of the attributes of the annotated entity class as attribute nodes in the NamedEntityGraph without the need to explicitly list them. Included attributes can still be fully specified by an attribute node referencing a subgraph.true
true
PERSISTENCE:JAVADOC:3417Stringjakarta.persistence.NamedEntityGraph.name
(Optional) The name of the entity graph. Defaults to the entity name of the root entity.true
true
PERSISTENCE:JAVADOC:3418NamedSubgraph[]jakarta.persistence.NamedEntityGraph.subclassSubgraphs
(Optional) A list of subgraphs that will add additional attributes for subclasses of the annotated entity class to the entity graph. Specified attributes from superclasses are included in subclasses.true
true
PERSISTENCE:JAVADOC:3419NamedSubgraph[]jakarta.persistence.NamedEntityGraph.subgraphs
(Optional) A list of subgraphs that are included in the entity graph. These are referenced by name from NamedAttributeNode definitions.true
true
PERSISTENCE:JAVADOC:3420NamedEntityGraph[]jakarta.persistence.NamedEntityGraphs.value

true
true
PERSISTENCE:JAVADOC:3421NamedAttributeNode[]jakarta.persistence.NamedSubgraph.attributeNodes
(Required) The list of the attributes of the class that must be included. If the named subgraph corresponds to a subclass of the class referenced by the corresponding attribute node, then only subclass-specific attributes are listed.true
true
PERSISTENCE:JAVADOC:3422Stringjakarta.persistence.NamedSubgraph.name
(Required) The name of the subgraph as referenced from a NamedAttributeNode element.true
true
PERSISTENCE:JAVADOC:3423Classjakarta.persistence.NamedSubgraph.type
(Optional) The type represented by this subgraph. The element must be specified when this subgraph is extending a definition on behalf of a subclass.true
true
PERSISTENCE:JAVADOC:3424voidjakarta.persistence.Subgraph.addAttributeNodes
( String[] )
Add one or more attribute nodes to the entity graph.true
true
PERSISTENCE:JAVADOC:3427voidjakarta.persistence.Subgraph.addAttributeNodes
( Attribute[] )
Add one or more attribute nodes to the entity graph.true
true
PERSISTENCE:JAVADOC:3429Subgraphjakarta.persistence.Subgraph.addKeySubgraph
( Attribute )
Add a node to the graph that corresponds to a map key that is a managed type. This allows for construction of multinode entity graphs that include related managed types.true
true
PERSISTENCE:JAVADOC:3432Subgraphjakarta.persistence.Subgraph.addKeySubgraph
( Attribute ,
Class )
Add a node to the graph that corresponds to a map key that is a managed type with inheritance. This allows for construction of multi-node entity graphs that include related managed types. Subclass subgraphs will automatically include the specified attributes of superclass subgraphstrue
true
PERSISTENCE:JAVADOC:3435Subgraphjakarta.persistence.Subgraph.addKeySubgraph
( String )
Add a node to the graph that corresponds to a map key that is a managed type. This allows for construction of multi-node entity graphs that include related managed types.true
true
PERSISTENCE:JAVADOC:3439Subgraphjakarta.persistence.Subgraph.addKeySubgraph
( String ,
Class )
Add a node to the graph that corresponds to a map key that is a managed type with inheritance. This allows for construction of multi-node entity graphs that include related managed types. Subclass subgraphs will include the specified attributes of superclass subgraphstrue
true
PERSISTENCE:JAVADOC:3443Subgraphjakarta.persistence.Subgraph.addSubgraph
( Attribute )
Add a node to the graph that corresponds to a managed type. This allows for construction of multi-node entity graphs that include related managed types.true
true
PERSISTENCE:JAVADOC:3446Subgraphjakarta.persistence.Subgraph.addSubgraph
( Attribute ,
Class )
Add a node to the graph that corresponds to a managed type with inheritance. This allows for multiple subclass subgraphs to be defined for this node of the entity graph. Subclass subgraphs will automatically include the specified attributes of superclass subgraphstrue
true
PERSISTENCE:JAVADOC:3449Subgraphjakarta.persistence.Subgraph.addSubgraph
( String )
Add a node to the graph that corresponds to a managed type. This allows for construction of multi-node entity graphs that include related managed types.true
true
PERSISTENCE:JAVADOC:3453Subgraphjakarta.persistence.Subgraph.addSubgraph
( String ,
Class )
Add a node to the graph that corresponds to a managed type with inheritance. This allows for multiple subclass subgraphs to be defined for this node of the entity graph. Subclass subgraphs will automatically include the specified attributes of superclass subgraphstrue
true
PERSISTENCE:JAVADOC:3457Listjakarta.persistence.Subgraph.getAttributeNodes
Return the attribute nodes corresponding to the attributes of this managed type that are included in the subgraph.true
true
PERSISTENCE:JAVADOC:3458Classjakarta.persistence.Subgraph.getClassType
Return the type for which this subgraph was defined.true
true
PERSISTENCE:JAVADOC:3463booleanjakarta.persistence.spi.PersistenceProvider.generateSchema
( String ,
Map )
Create database schemas and/or tables and/or create DDL scripts as determined by the supplied properties. Called by the Persistence class when schema generation is to occur as a separate phase from creation of the entity manager factory.true
false
PERSISTENCE:JAVADOC:3465ForeignKeyjakarta.persistence.AssociationOverride.foreignKey
(Optional) Used to specify or control the generation of a foreign key constraint for the columns corresponding to the joinColumns element when table generation is in effect. If both this element and the foreignKey element of any of the joinColumns elements are specified, the behavior is undefined. If no foreign key annotation element is specified in either location, the persistence provider's default foreign key strategy will apply.true
true
PERSISTENCE:JAVADOC:3466Mapjakarta.persistence.AttributeNode.getKeySubgraphs
Return the Map #060;Class, Subgraph #062; of subgraphs associated with this attribute node's map key.true
true
PERSISTENCE:JAVADOC:3467Mapjakarta.persistence.AttributeNode.getSubgraphs
Return the Map #060;Class, Subgraph #062; of subgraphs associated with this attribute node.true
true
PERSISTENCE:JAVADOC:3468ForeignKeyjakarta.persistence.CollectionTable.foreignKey
(Optional) Used to specify or control the generation of a foreign key constraint for the columns corresponding to the joinColumns element when table generation is in effect. If both this element and the foreignKey element of any of the joinColumns elements are specified, the behavior is undefined. If no foreign key annotation element is specified in either location, the persistence provider's default foreign key strategy will apply.true
true
PERSISTENCE:JAVADOC:3469ConstraintModejakarta.persistence.ConstraintMode.valueOf
( String )

true
true
PERSISTENCE:JAVADOC:3470ConstraintMode[]jakarta.persistence.ConstraintMode.values

true
true
PERSISTENCE:JAVADOC:3471ConstraintModejakarta.persistence.ForeignKey.value
(Optional) Used to specify whether a foreign key constraint should be generated when schema generation is in effect. A value of CONSTRAINT will cause the persistence provider to generate a foreign key constraint. If the foreignKeyDefinition element is not specified, the provider will generate a constraint whose update and delete actions it determines most appropriate for the join column(s) to which the foreign key annotation is applied. A value of NO_CONSTRAINT will result in no constraint being generated. A value of PROVIDER_DEFAULT will result in the provider's default behavior (which may or may not result in the generation of a constraint for the given join column(s).true
true
PERSISTENCE:JAVADOC:3472ForeignKeyjakarta.persistence.JoinTable.foreignKey
(Optional) Used to specify or control the generation of a foreign key constraint for the columns corresponding to the joinColumns element when table generation is in effect. If both this element and the foreignKey element of any of the joinColumns elements are specified, the behavior is undefined. If no foreign key annotation element is specified in either location, the persistence provider's default foreign key strategy will apply.true
true
PERSISTENCE:JAVADOC:3473ForeignKeyjakarta.persistence.JoinTable.inverseForeignKey
(Optional) Used to specify or control the generation of a foreign key constraint for the columns corresponding to the inverseJoinColumns element when table generation is in effect. If both this element and the foreignKey element of any of the inverseJoinColumns elements are specified, the behavior is undefined. If no foreign key annotation element is specified in either location, the persistence provider's default foreign key strategy will apply.true
true
PERSISTENCE:JAVADOC:3474ForeignKeyjakarta.persistence.SecondaryTable.foreignKey
(Optional) Used to specify or control the generation of a foreign key constraint for the columns corresponding to the pkJoinColumns element when table generation is in effect. If both this element and the foreignKey element of any of the pkJoinColumns elements are specified, the behavior is undefined. If no foreign key annotation element is specified in either location, the persistence provider's default foreign key strategy will apply.true
true
PERSISTENCE:JAVADOC:3475intjakarta.persistence.StoredProcedureQuery.executeUpdate
Return the update count of -1 if there is no pending result or if the first result is not an update count. The provider will call execute on the query if needed.true
true
PERSISTENCE:JAVADOC:3479Listjakarta.persistence.StoredProcedureQuery.getResultList
Retrieve the list of results from the next result set. The provider will call execute on the query if needed. A REF_CURSOR result set, if any, will be retrieved in the order the REF_CURSOR parameter was registered with the query.true
true
PERSISTENCE:JAVADOC:3482Objectjakarta.persistence.StoredProcedureQuery.getSingleResult
Retrieve a single result from the next result set. The provider will call execute on the query if needed. A REF_CURSOR result set, if any, will be retrieved in the order the REF_CURSOR parameter was registered with the query.true
true
PERSISTENCE:JAVADOC:3487Streamjakarta.persistence.Query.getResultStream
Execute a SELECT query and return the query results as an untyped java.util.stream.Stream. By default this method delegates to getResultList().stream(), however persistence provider may choose to override this method to provide additional capabilities.true
true
PERSISTENCE:JAVADOC:3488SequenceGenerator[]jakarta.persistence.SequenceGenerators.value

true
true
PERSISTENCE:JAVADOC:3489TableGenerator[]jakarta.persistence.TableGenerators.value

true
true
PERSISTENCE:JAVADOC:3490Streamjakarta.persistence.TypedQuery.getResultStream
Execute a SELECT query and return the query results as a typed java.util.stream.Stream. By default this method delegates to getResultList().stream(), however persistence provider may choose to override this method to provide additional capabilities.true
true