ID | Return | Method/Field | Description | Required | Deprecated | Testable |
PERSISTENCE:JAVADOC:1 | JoinColumn[] | jakarta.persistence.AssociationOverride.joinColumns
|
The join column that is being mapped to the persistent attribute.
The mapping type will remain the same as is defined in the mapped superclass.
| true |
| true |
PERSISTENCE:JAVADOC:2 | String | jakarta.persistence.AssociationOverride.name
|
The name of the relationship property whose mapping is being overridden if property-based access is being used, or the name of the relationship field if field-based access is used.
| true |
| true |
PERSISTENCE:JAVADOC:3 | AssociationOverride[] | jakarta.persistence.AssociationOverrides.value
|
Mapping overrides of relationship properties or fields
| true |
| true |
PERSISTENCE:JAVADOC:4 | Column | jakarta.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:5 | String | jakarta.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:6 | AttributeOverride[] | jakarta.persistence.AttributeOverrides.value
|
One or more mapping override
| true |
| true |
PERSISTENCE:JAVADOC:7 | FetchType | jakarta.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:8 | boolean | jakarta.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:9 | CascadeType | jakarta.persistence.CascadeType.valueOf
(
String
)
|
| true |
| true |
PERSISTENCE:JAVADOC:10 | CascadeType[] | jakarta.persistence.CascadeType.values
|
| true |
| true |
PERSISTENCE:JAVADOC:11 | String | jakarta.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:12 | boolean | jakarta.persistence.Column.insertable
|
(Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider.
| false |
| true |
PERSISTENCE:JAVADOC:13 | int | jakarta.persistence.Column.length
|
(Optional) The column length.
(Applies only if a string-valued column is used.)
| false |
| true |
PERSISTENCE:JAVADOC:14 | String | jakarta.persistence.Column.name
|
(Optional) The name of the column.
Defaults to the property or field name.
| true |
| true |
PERSISTENCE:JAVADOC:15 | boolean | jakarta.persistence.Column.nullable
|
Optional) Whether the database column is nullable.
| true |
| true |
PERSISTENCE:JAVADOC:16 | int | jakarta.persistence.Column.precision
|
(Optional) The precision for a decimal (exact numeric) column.
(Applies only if a decimal column is used.) Value must be set by developer if used when generating the DDL for the column.
| false |
| true |
PERSISTENCE:JAVADOC:17 | int | jakarta.persistence.Column.scale
|
(Optional) The scale for a decimal (exact numeric) column.
(Applies only if a decimal column is used.)
| false |
| true |
PERSISTENCE:JAVADOC:18 | String | jakarta.persistence.Column.table
|
(Optional) The name of the table that contains the column.
If absent the column is assumed to be in the primary table.
| false |
| true |
PERSISTENCE:JAVADOC:19 | boolean | jakarta.persistence.Column.unique
|
(Optional) Whether the property is a unique key.
This is a shortcut for the UniqueConstraint annotation at the table level and is useful for when the unique key constraint is only a single field. This constraint applies in addition to any constraint entailed by primary key mapping and to constraints specified at the table level.
| false |
| true |
PERSISTENCE:JAVADOC:20 | boolean | jakarta.persistence.Column.updatable
|
(Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider.
| true |
| true |
PERSISTENCE:JAVADOC:21 | String | jakarta.persistence.ColumnResult.name
|
The name of a column in the SELECT clause of a SQL query
| true |
| true |
PERSISTENCE:JAVADOC:22 | String | jakarta.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:23 | DiscriminatorType | jakarta.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:24 | int | jakarta.persistence.DiscriminatorColumn.length
|
(Optional) The column length for String-based discriminator types.
Ignored for other discriminator types.
| false |
| true |
PERSISTENCE:JAVADOC:25 | String | jakarta.persistence.DiscriminatorColumn.name
|
(Optional) The name of column to be used for the discriminator.
| false |
| true |
PERSISTENCE:JAVADOC:26 | DiscriminatorType | jakarta.persistence.DiscriminatorType.valueOf
(
String
)
|
| true |
| true |
PERSISTENCE:JAVADOC:27 | DiscriminatorType[] | jakarta.persistence.DiscriminatorType.values
|
| true |
| true |
PERSISTENCE:JAVADOC:28 | String | jakarta.persistence.DiscriminatorValue.value
|
(Optional) The value that indicates that the row is an entity of the annotated entity type.
If the DiscriminatorValue annotation is not specified and a discriminator column is used, a provider-specific function will be used to generate a value representing the entity type. If the DiscriminatorType is DiscriminatorType#STRING STRING, the discriminator value default is the entity name.
| true |
| true |
PERSISTENCE:JAVADOC:29 | String | jakarta.persistence.Entity.name
|
The name of an entity.
Defaults to the unqualified name of the entity class. This name is used to refer to the entity in queries. The name must not be a reserved literal in the Java Persistence query language.
| true |
| true |
PERSISTENCE:JAVADOC:30 | EntityExistsException | jakarta.persistence.EntityExistsException.EntityExistsException
|
Constructs a new EntityExistsException exception with null as its detail message.
| true |
| true |
PERSISTENCE:JAVADOC:31 | EntityExistsException | jakarta.persistence.EntityExistsException.EntityExistsException
(
String
)
|
Constructs a new EntityExistsException exception with the specified detail message.
| true |
| true |
PERSISTENCE:JAVADOC:32 | EntityExistsException | jakarta.persistence.EntityExistsException.EntityExistsException
(
String
, Throwable
)
|
Constructs a new EntityExistsException exception with the specified detail message and cause.
| true |
| true |
PERSISTENCE:JAVADOC:33 | EntityExistsException | jakarta.persistence.EntityExistsException.EntityExistsException
(
Throwable
)
|
Constructs a new EntityExistsException exception with the specified cause.
| true |
| true |
PERSISTENCE:JAVADOC:34 | Class[] | jakarta.persistence.EntityListeners.value
|
The callback listener classes
| true |
| true |
PERSISTENCE:JAVADOC:35 | void | jakarta.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:36 | void | jakarta.persistence.EntityManager.close
|
Close an application-managed EntityManager.
After the close method has been invoked, all methods on the EntityManager instance and any Query objects obtained from it will throw the IllegalStateException except for getTransaction and isOpen (which will return false). If this method is called when the EntityManager is associated with an active transaction, the persistence context remains managed until the transaction completes.
| true |
| true |
PERSISTENCE:JAVADOC:37 | boolean | jakarta.persistence.EntityManager.contains
(
Object
)
|
Check if the instance belongs to the current persistence context.
| true |
| true |
PERSISTENCE:JAVADOC:38 | Query | jakarta.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:39 | Query | jakarta.persistence.EntityManager.createNativeQuery
(
String
)
|
Create an instance of Query for executing a native SQL statement, e.g., for update or delete.
| true |
| true |
PERSISTENCE:JAVADOC:40 | Query | jakarta.persistence.EntityManager.createNativeQuery
(
String
, Class
)
|
Create an instance of Query for executing a native SQL query.
| true |
| true |
PERSISTENCE:JAVADOC:41 | Query | jakarta.persistence.EntityManager.createNativeQuery
(
String
, String
)
|
Create an instance of Query for executing a native SQL query.
| true |
| true |
PERSISTENCE:JAVADOC:42 | Query | jakarta.persistence.EntityManager.createQuery
(
String
)
|
Create an instance of Query for executing a Java Persistence query language statement.
| true |
| true |
PERSISTENCE:JAVADOC:43 | Object | jakarta.persistence.EntityManager.find
(
Class
, Object
)
|
Find by primary key.
| true |
| true |
PERSISTENCE:JAVADOC:44 | void | jakarta.persistence.EntityManager.flush
|
Synchronize the persistence context to the underlying database.
| true |
| true |
PERSISTENCE:JAVADOC:45 | Object | jakarta.persistence.EntityManager.getDelegate
|
Return the underlying provider object for the EntityManager, if available.
The result of this method is implementation specific.
| true |
| false |
PERSISTENCE:JAVADOC:46 | FlushModeType | jakarta.persistence.EntityManager.getFlushMode
|
Get the flush mode that applies to all objects contained in the persistence context.
| true |
| true |
PERSISTENCE:JAVADOC:47 | Object | jakarta.persistence.EntityManager.getReference
(
Class
, Object
)
|
Get an instance, whose state may be lazily fetched.
If the requested instance does not exist in the database, throws EntityNotFoundException when the instance state is first accessed. (The persistence provider runtime is permitted to throw EntityNotFoundException when #getReference is called.) The application should not expect that the instance state will be available upon detachment, unless it was accessed by the application while the entity manager was open.
| true |
| true |
PERSISTENCE:JAVADOC:48 | EntityTransaction | jakarta.persistence.EntityManager.getTransaction
|
Returns the resource-level transaction object.
The EntityTransaction instance may be used serially to begin and commit multiple transactions.
| true |
| true |
PERSISTENCE:JAVADOC:49 | boolean | jakarta.persistence.EntityManager.isOpen
|
Determine whether the EntityManager is open.
| true |
| true |
PERSISTENCE:JAVADOC:50 | void | jakarta.persistence.EntityManager.joinTransaction
|
Indicate to the EntityManager that a JTA transaction is active.
This method should be called on a JTA application managed EntityManager that was created outside the scope of the active transaction to associate it with the current JTA transaction.
| true |
| true |
PERSISTENCE:JAVADOC:51 | void | jakarta.persistence.EntityManager.lock
(
Object
, LockModeType
)
|
Set the lock mode for an entity object contained in the persistence context.
| true |
| true |
PERSISTENCE:JAVADOC:52 | Object | jakarta.persistence.EntityManager.merge
(
Object
)
|
Merge the state of the given entity into the current persistence context.
| true |
| true |
PERSISTENCE:JAVADOC:53 | void | jakarta.persistence.EntityManager.persist
(
Object
)
|
Make an entity instance managed and persistent.
| true |
| true |
PERSISTENCE:JAVADOC:54 | void | jakarta.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:55 | void | jakarta.persistence.EntityManager.remove
(
Object
)
|
Remove the entity instance.
| true |
| true |
PERSISTENCE:JAVADOC:56 | void | jakarta.persistence.EntityManager.setFlushMode
(
FlushModeType
)
|
Set the flush mode that applies to all objects contained in the persistence context.
| true |
| true |
PERSISTENCE:JAVADOC:57 | void | jakarta.persistence.EntityManagerFactory.close
|
Close the factory, releasing any resources that it holds.
After a factory instance is closed, all methods invoked on it will throw an IllegalStateException, except for isOpen, which will return false. Once an EntityManagerFactory has been closed, all its entity managers are considered to be in the closed state.
| true |
| true |
PERSISTENCE:JAVADOC:58 | EntityManager | jakarta.persistence.EntityManagerFactory.createEntityManager
|
Create a new EntityManager.
This method returns a new EntityManager instance each time it is invoked. The isOpen method will return true on the returned instance.
| true |
| true |
PERSISTENCE:JAVADOC:59 | EntityManager | jakarta.persistence.EntityManagerFactory.createEntityManager
(
Map
)
|
Create a new EntityManager with the specified Map of properties.
This method returns a new EntityManager instance each time it is invoked. The isOpen method will return true on the returned instance.
| true |
| true |
PERSISTENCE:JAVADOC:60 | boolean | jakarta.persistence.EntityManagerFactory.isOpen
|
Indicates whether or not this factory is open.
Returns true until a call to close has been made.
| true |
| true |
PERSISTENCE:JAVADOC:61 | EntityNotFoundException | jakarta.persistence.EntityNotFoundException.EntityNotFoundException
|
Constructs a new EntityNotFoundException exception with null as its detail message.
| true |
| true |
PERSISTENCE:JAVADOC:62 | EntityNotFoundException | jakarta.persistence.EntityNotFoundException.EntityNotFoundException
(
String
)
|
Constructs a new EntityNotFoundException exception with the specified detail message.
| true |
| true |
PERSISTENCE:JAVADOC:63 | String | jakarta.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:64 | Class | jakarta.persistence.EntityResult.entityClass
|
The class of the result
| true |
| true |
PERSISTENCE:JAVADOC:65 | FieldResult[] | 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:66 | void | jakarta.persistence.EntityTransaction.begin
|
Start the resource transaction.
| true |
| true |
PERSISTENCE:JAVADOC:67 | void | jakarta.persistence.EntityTransaction.commit
|
Commit the current transaction, writing any unflushed changes to the database.
| true |
| true |
PERSISTENCE:JAVADOC:68 | boolean | jakarta.persistence.EntityTransaction.getRollbackOnly
|
Determine whether the current transaction has been marked for rollback.
| true |
| true |
PERSISTENCE:JAVADOC:69 | boolean | jakarta.persistence.EntityTransaction.isActive
|
Indicate whether a transaction is in progress.
| true |
| true |
PERSISTENCE:JAVADOC:70 | void | jakarta.persistence.EntityTransaction.rollback
|
Roll back the current transaction
| true |
| true |
PERSISTENCE:JAVADOC:71 | void | jakarta.persistence.EntityTransaction.setRollbackOnly
|
Mark the current transaction so that the only possible outcome of the transaction is for the transaction to be rolled back.
| true |
| true |
PERSISTENCE:JAVADOC:72 | EnumType | jakarta.persistence.Enumerated.value
|
(Optional) The type used in mapping an enum type.
| true |
| true |
PERSISTENCE:JAVADOC:73 | EnumType | jakarta.persistence.EnumType.valueOf
(
String
)
|
| true |
| true |
PERSISTENCE:JAVADOC:74 | EnumType[] | jakarta.persistence.EnumType.values
|
| true |
| true |
PERSISTENCE:JAVADOC:75 | FetchType | jakarta.persistence.FetchType.valueOf
(
String
)
|
| true |
| true |
PERSISTENCE:JAVADOC:76 | FetchType[] | jakarta.persistence.FetchType.values
|
| true |
| true |
PERSISTENCE:JAVADOC:77 | String | jakarta.persistence.FieldResult.column
|
Name of the column in the SELECT clause - i.e., column aliases, if applicable.
| true |
| true |
PERSISTENCE:JAVADOC:78 | String | jakarta.persistence.FieldResult.name
|
Name of the persistent field or property of the class.
| true |
| true |
PERSISTENCE:JAVADOC:79 | FlushModeType | jakarta.persistence.FlushModeType.valueOf
(
String
)
|
| true |
| true |
PERSISTENCE:JAVADOC:80 | FlushModeType[] | jakarta.persistence.FlushModeType.values
|
| true |
| true |
PERSISTENCE:JAVADOC:81 | String | jakarta.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:82 | GenerationType | jakarta.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:83 | GenerationType | jakarta.persistence.GenerationType.valueOf
(
String
)
|
| true |
| true |
PERSISTENCE:JAVADOC:84 | GenerationType[] | jakarta.persistence.GenerationType.values
|
| true |
| true |
PERSISTENCE:JAVADOC:85 | Class | jakarta.persistence.IdClass.value
|
Primary key class
| true |
| true |
PERSISTENCE:JAVADOC:86 | InheritanceType | jakarta.persistence.Inheritance.strategy
|
The strategy to be used
| true |
| true |
PERSISTENCE:JAVADOC:87 | InheritanceType | jakarta.persistence.InheritanceType.valueOf
(
String
)
|
| true |
| true |
PERSISTENCE:JAVADOC:88 | InheritanceType[] | jakarta.persistence.InheritanceType.values
|
| true |
| true |
PERSISTENCE:JAVADOC:89 | String | jakarta.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:90 | boolean | jakarta.persistence.JoinColumn.insertable
|
(Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider.
| true |
| true |
PERSISTENCE:JAVADOC:91 | String | jakarta.persistence.JoinColumn.name
|
(Optional) The name of the foreign key column.
The table in which it is found depends upon the context. If the join is for a OneToOne or Many- ToOne mapping, the foreign key column is in the table of the source entity. If the join is for a ManyToMany, the foreign key is in a join table. Default (only applies if a single join column is used): The concatenation of the following: the name of the referencing relationship property or field of the referencing entity; "_"; the name of the referenced primary key column. If there is no such referencing relationship property or field in the entity, the join column name is formed as the concatenation of the following: the name of the entity; "_"; the name of the referenced primary key column.
| true |
| true |
PERSISTENCE:JAVADOC:92 | boolean | jakarta.persistence.JoinColumn.nullable
|
(Optional) Whether the foreign key column is nullable.
| true |
| true |
PERSISTENCE:JAVADOC:93 | String | jakarta.persistence.JoinColumn.referencedColumnName
|
(Optional) The name of the column referenced by this foreign key column.
When used with relationship mappings, the referenced column is in the table of the target entity. When used inside a JoinTable annotation, the referenced key column is in the entity table of the owning entity, or inverse entity if the join is part of the inverse join definition. Default (only applies if single join column is being used): The same name as the primary key column of the referenced table.
| true |
| true |
PERSISTENCE:JAVADOC:94 | String | jakarta.persistence.JoinColumn.table
|
(Optional) The name of the table that contains the column.
If a table is not specified, the column is assumed to be in the primary table of the applicable entity.
| true |
| true |
PERSISTENCE:JAVADOC:95 | boolean | jakarta.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:96 | boolean | jakarta.persistence.JoinColumn.updatable
|
(Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider.
| true |
| true |
PERSISTENCE:JAVADOC:97 | JoinColumn[] | jakarta.persistence.JoinColumns.value
|
| true |
| true |
PERSISTENCE:JAVADOC:98 | String | jakarta.persistence.JoinTable.catalog
|
(Optional) The catalog of the table.
Defaults to the default catalog.
| true |
| true |
PERSISTENCE:JAVADOC:99 | JoinColumn[] | 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:100 | JoinColumn[] | 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:101 | String | jakarta.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:102 | String | jakarta.persistence.JoinTable.schema
|
(Optional) The schema of the table.
Defaults to the default schema for user.
| true |
| true |
PERSISTENCE:JAVADOC:103 | UniqueConstraint[] | 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:104 | LockModeType | jakarta.persistence.LockModeType.valueOf
(
String
)
|
| true |
| true |
PERSISTENCE:JAVADOC:105 | LockModeType[] | jakarta.persistence.LockModeType.values
|
| true |
| true |
PERSISTENCE:JAVADOC:106 | CascadeType[] | jakarta.persistence.ManyToMany.cascade
|
(Optional) The operations that must be cascaded to the target of the association.
Defaults to no operations being cascaded.
| true |
| true |
PERSISTENCE:JAVADOC:107 | FetchType | jakarta.persistence.ManyToMany.fetch
|
(Optional) Whether the association should be lazily loaded or must be eagerly fetched.
The FetchType#EAGER EAGER strategy is a requirement on the persistenceprovider runtime that the associatedentities must be eagerly fetched. The FetchType#LAZY LAZY strategy is a hint to the persistence provider runtime.
| true |
| true |
PERSISTENCE:JAVADOC:108 | String | jakarta.persistence.ManyToMany.mappedBy
|
The field that owns the relationship.
Required unless the relationship is unidirectional.
| true |
| true |
PERSISTENCE:JAVADOC:109 | Class | jakarta.persistence.ManyToMany.targetEntity
|
(Optional) The entity class that is the target of the association.
Optional only if the collection property is defined using Java generics. Must be specified otherwise. Defaults to the parameterized type of the collection when defined using generics.
| true |
| true |
PERSISTENCE:JAVADOC:110 | CascadeType[] | 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:111 | FetchType | jakarta.persistence.ManyToOne.fetch
|
(Optional) Whether the association should be lazily loaded or must be eagerly fetched.
The FetchType#EAGER EAGER strategy is a requirement on the persistence provider runtime that the associated entity must be eagerly fetched. The FetchType#LAZY LAZY strategy is a hint to the persistence provider runtime.
| true |
| true |
PERSISTENCE:JAVADOC:112 | boolean | jakarta.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:113 | Class | jakarta.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:114 | String | jakarta.persistence.MapKey.name
|
The name of the persistent field or property of the associated entity that is used as the map key.
If the name element is not specified, the primary key of the associated entity is used as the map key. If the primary key is a composite primary key and is mapped as IdClass, an instance of the primary key class is used as the key.
| true |
| true |
PERSISTENCE:JAVADOC:115 | NamedNativeQuery[] | jakarta.persistence.NamedNativeQueries.value
|
Array of native SQL named queries
| true |
| true |
PERSISTENCE:JAVADOC:116 | QueryHint[] | jakarta.persistence.NamedNativeQuery.hints
|
Vendor-specific query hints
| true |
| false |
PERSISTENCE:JAVADOC:117 | String | jakarta.persistence.NamedNativeQuery.name
|
Is used to refer to the query when using the EntityManager methods that create query objects.
| true |
| true |
PERSISTENCE:JAVADOC:118 | String | jakarta.persistence.NamedNativeQuery.query
|
The SQL query string
| true |
| true |
PERSISTENCE:JAVADOC:119 | Class | jakarta.persistence.NamedNativeQuery.resultClass
|
The class of the result
| true |
| true |
PERSISTENCE:JAVADOC:120 | String | jakarta.persistence.NamedNativeQuery.resultSetMapping
|
The name of a SqlResultSetMapping, as defined in metadata
| true |
| true |
PERSISTENCE:JAVADOC:121 | NamedQuery[] | jakarta.persistence.NamedQueries.value
|
An array of named Java Persistence query language queries.
| true |
| true |
PERSISTENCE:JAVADOC:122 | QueryHint[] | jakarta.persistence.NamedQuery.hints
|
Vendor-specific query hints
| true |
| false |
PERSISTENCE:JAVADOC:123 | String | jakarta.persistence.NamedQuery.name
|
Refers to the query when using the EntityManager methods that create query objects.
| true |
| true |
PERSISTENCE:JAVADOC:124 | String | jakarta.persistence.NamedQuery.query
|
The query string in the Java Persistence query language
| true |
| true |
PERSISTENCE:JAVADOC:125 | NonUniqueResultException | jakarta.persistence.NonUniqueResultException.NonUniqueResultException
|
Constructs a new NonUniqueResultException exception with null as its detail message.
| true |
| true |
PERSISTENCE:JAVADOC:126 | NonUniqueResultException | jakarta.persistence.NonUniqueResultException.NonUniqueResultException
(
String
)
|
Constructs a new NonUniqueResultException exception with the specified detail message.
| true |
| true |
PERSISTENCE:JAVADOC:127 | NoResultException | jakarta.persistence.NoResultException.NoResultException
|
Constructs a new NoResultException exception with null as its detail message.
| true |
| true |
PERSISTENCE:JAVADOC:128 | NoResultException | jakarta.persistence.NoResultException.NoResultException
(
String
)
|
Constructs a new NoResultException exception with the specified detail message.
| true |
| true |
PERSISTENCE:JAVADOC:129 | CascadeType[] | jakarta.persistence.OneToMany.cascade
|
(Optional) The operations that must be cascaded to the target of the association.
Defaults to no operations being cascaded.
| true |
| true |
PERSISTENCE:JAVADOC:130 | FetchType | jakarta.persistence.OneToMany.fetch
|
(Optional) Whether the association should be lazily loaded or must be eagerly fetched.
The FetchType#EAGER EAGER strategy is a requirement on the persistenceprovider runtime that the associatedentities must be eagerly fetched. The FetchType#LAZY LAZY strategy is a hint to the persistence provider runtime.
| true |
| true |
PERSISTENCE:JAVADOC:131 | String | jakarta.persistence.OneToMany.mappedBy
|
The field that owns the relationship.
Required unless the relationship is unidirectional.
| true |
| true |
PERSISTENCE:JAVADOC:132 | Class | jakarta.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:133 | CascadeType[] | 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:134 | FetchType | jakarta.persistence.OneToOne.fetch
|
(Optional) Whether the association should be lazily loaded or must be eagerly fetched.
The FetchType#EAGER EAGER strategy is a requirement on the persistence provider runtime that the associated entity must be eagerly fetched. The FetchType#LAZY LAZY strategy is a hint to the persistence provider runtime.
| true |
| true |
PERSISTENCE:JAVADOC:135 | String | jakarta.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:136 | boolean | jakarta.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:137 | Class | jakarta.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:138 | Object | jakarta.persistence.OptimisticLockException.getEntity
|
Returns the entity that caused this exception.
| true |
| true |
PERSISTENCE:JAVADOC:139 | OptimisticLockException | jakarta.persistence.OptimisticLockException.OptimisticLockException
|
Constructs a new OptimisticLockException exception with null as its detail message.
| true |
| true |
PERSISTENCE:JAVADOC:140 | OptimisticLockException | jakarta.persistence.OptimisticLockException.OptimisticLockException
(
String
)
|
Constructs a new OptimisticLockException exception with the specified detail message.
| true |
| true |
PERSISTENCE:JAVADOC:141 | OptimisticLockException | jakarta.persistence.OptimisticLockException.OptimisticLockException
(
String
, Throwable
)
|
Constructs a new OptimisticLockException exception with the specified detail message and cause.
| true |
| true |
PERSISTENCE:JAVADOC:142 | OptimisticLockException | jakarta.persistence.OptimisticLockException.OptimisticLockException
(
Throwable
)
|
Constructs a new OptimisticLockException exception with the specified cause.
| true |
| true |
PERSISTENCE:JAVADOC:143 | OptimisticLockException | jakarta.persistence.OptimisticLockException.OptimisticLockException
(
Object
)
|
Constructs a new OptimisticLockException exception with the specified entity.
| true |
| true |
PERSISTENCE:JAVADOC:144 | OptimisticLockException | jakarta.persistence.OptimisticLockException.OptimisticLockException
(
String
, Throwable
, Object
)
|
Constructs a new OptimisticLockException exception with the specified detail message, cause, and entity.
| true |
| true |
PERSISTENCE:JAVADOC:145 | String | jakarta.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:146 | EntityManagerFactory | jakarta.persistence.Persistence.createEntityManagerFactory
(
String
)
|
Create and return an EntityManagerFactory for the named persistence unit.
| true |
| false |
PERSISTENCE:JAVADOC:147 | EntityManagerFactory | jakarta.persistence.Persistence.createEntityManagerFactory
(
String
, Map
)
|
Create and return an EntityManagerFactory for the named persistence unit using the given properties.
| true |
| false |
PERSISTENCE:JAVADOC:148 | Persistence | jakarta.persistence.Persistence.Persistence
|
| true |
| false |
PERSISTENCE:JAVADOC:149 | String | jakarta.persistence.PersistenceContext.name
|
The name by which the entity manager is to be accessed in the environment referencing context, and is not needed when dependency injection is used.
| true |
| true |
PERSISTENCE:JAVADOC:150 | PersistenceProperty[] | jakarta.persistence.PersistenceContext.properties
|
Used to specify properties for the container or persistence provider.
Vendor specific properties may be included in this set of properties. Properties that are not recognized by a vendor are ignored.
| true |
| false |
PERSISTENCE:JAVADOC:151 | PersistenceContextType | jakarta.persistence.PersistenceContext.type
|
Specifies whether this is a transaction-scoped persistence context or an extended persistence context.
| true |
| true |
PERSISTENCE:JAVADOC:152 | String | jakarta.persistence.PersistenceContext.unitName
|
The name of the persistence unit.
If the unitName element is specified, the persistence unit for the entity manager that is accessible in JNDI must have the same name.
| true |
| true |
PERSISTENCE:JAVADOC:153 | PersistenceContext[] | jakarta.persistence.PersistenceContexts.value
|
One or more persistence context
| true |
| true |
PERSISTENCE:JAVADOC:154 | PersistenceContextType | jakarta.persistence.PersistenceContextType.valueOf
(
String
)
|
| true |
| true |
PERSISTENCE:JAVADOC:155 | PersistenceContextType[] | jakarta.persistence.PersistenceContextType.values
|
| true |
| true |
PERSISTENCE:JAVADOC:156 | PersistenceException | jakarta.persistence.PersistenceException.PersistenceException
|
Constructs a new PersistenceException exception with null as its detail message.
| true |
| true |
PERSISTENCE:JAVADOC:157 | PersistenceException | jakarta.persistence.PersistenceException.PersistenceException
(
String
)
|
Constructs a new PersistenceException exception with the specified detail message.
| true |
| true |
PERSISTENCE:JAVADOC:158 | PersistenceException | jakarta.persistence.PersistenceException.PersistenceException
(
String
, Throwable
)
|
Constructs a new PersistenceException exception with the specified detail message and cause.
| true |
| true |
PERSISTENCE:JAVADOC:159 | PersistenceException | jakarta.persistence.PersistenceException.PersistenceException
(
Throwable
)
|
Constructs a new PersistenceException exception with the specified cause.
| true |
| true |
PERSISTENCE:JAVADOC:160 | String | jakarta.persistence.PersistenceProperty.name
|
The name of the property
| true |
| false |
PERSISTENCE:JAVADOC:161 | String | jakarta.persistence.PersistenceProperty.value
|
The value of the property
| true |
| false |
PERSISTENCE:JAVADOC:162 | String | jakarta.persistence.PersistenceUnit.name
|
The name by which the entity manager factory is to be accessed in the environment referencing context, and is not needed when dependency injection is used.
| true |
| true |
PERSISTENCE:JAVADOC:163 | String | jakarta.persistence.PersistenceUnit.unitName
|
The name of the persistence unit as defined in the persistence.xml file.
If specified, the persistence unit for the entity manager factory that is accessible in JNDI must have the same name.
| true |
| true |
PERSISTENCE:JAVADOC:164 | PersistenceUnit[] | jakarta.persistence.PersistenceUnits.value
|
One or more PersistenceUnit annotations.
| true |
| true |
PERSISTENCE:JAVADOC:165 | String | jakarta.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:166 | String | jakarta.persistence.PrimaryKeyJoinColumn.name
|
The name of the primary key column of the current table.
Defaults to the same name as the primary key column of the primary table of the superclass (InheritanceType#JOINED JOINED mapping strategy); the same name as the primary key column of the primary table (SecondaryTable mapping); or the same name as the primary key column for the table for the referencing entity (OneToOne mapping)
| true |
| true |
PERSISTENCE:JAVADOC:167 | String | jakarta.persistence.PrimaryKeyJoinColumn.referencedColumnName
|
(Optional) The name of the primary key column of the table being joined to.
Defaults to the same name as the primary key column of the primary table of the superclass (InheritanceType#JOINED JOINED mapping strategy); the same name as the primary key column of the primary table (SecondaryTable mapping); or the same name as the primary key column for the table for the referencing entity (OneToOne mapping)
| true |
| true |
PERSISTENCE:JAVADOC:168 | PrimaryKeyJoinColumn[] | jakarta.persistence.PrimaryKeyJoinColumns.value
|
One or more PrimaryKeyJoinColumn annotations.
| true |
| true |
PERSISTENCE:JAVADOC:169 | int | jakarta.persistence.Query.executeUpdate
|
Execute an update or delete statement.
| true |
| true |
PERSISTENCE:JAVADOC:170 | List | jakarta.persistence.Query.getResultList
|
Execute a SELECT query and return the query results as a List.
| true |
| true |
PERSISTENCE:JAVADOC:171 | Object | jakarta.persistence.Query.getSingleResult
|
Execute a SELECT query that returns a single result.
| true |
| true |
PERSISTENCE:JAVADOC:172 | Query | jakarta.persistence.Query.setFirstResult
(
int
)
|
Set the position of the first result to retrieve.
| true |
| true |
PERSISTENCE:JAVADOC:173 | Query | jakarta.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:174 | Query | jakarta.persistence.Query.setHint
(
String
, Object
)
|
Set an implementation-specific hint.
If the hint name is not recognized, it is silently ignored.
| true |
| false |
PERSISTENCE:JAVADOC:175 | Query | jakarta.persistence.Query.setMaxResults
(
int
)
|
Set the maximum number of results to retrieve.
| true |
| true |
PERSISTENCE:JAVADOC:176 | Query | jakarta.persistence.Query.setParameter
(
String
, Object
)
|
Bind an argument to a named parameter.
| true |
| true |
PERSISTENCE:JAVADOC:177 | Query | jakarta.persistence.Query.setParameter
(
String
, Date
, TemporalType
)
|
Bind an instance of java.util.Date to a named parameter.
| true |
| true |
PERSISTENCE:JAVADOC:178 | Query | jakarta.persistence.Query.setParameter
(
String
, Calendar
, TemporalType
)
|
Bind an instance of java.util.Calendar to a named parameter.
| true |
| true |
PERSISTENCE:JAVADOC:179 | Query | jakarta.persistence.Query.setParameter
(
int
, Object
)
|
Bind an argument to a positional parameter.
| true |
| true |
PERSISTENCE:JAVADOC:180 | Query | jakarta.persistence.Query.setParameter
(
int
, Date
, TemporalType
)
|
Bind an instance of java.util.Date to a positional parameter.
| true |
| true |
PERSISTENCE:JAVADOC:181 | Query | jakarta.persistence.Query.setParameter
(
int
, Calendar
, TemporalType
)
|
Bind an instance of java.util.Calendar to a positional parameter.
| true |
| true |
PERSISTENCE:JAVADOC:182 | String | jakarta.persistence.QueryHint.name
|
Name of the hint
| true |
| false |
PERSISTENCE:JAVADOC:183 | String | jakarta.persistence.QueryHint.value
|
Value of the hint
| true |
| false |
PERSISTENCE:JAVADOC:184 | RollbackException | jakarta.persistence.RollbackException.RollbackException
|
Constructs a new RollbackException exception with null as its detail message.
| true |
| true |
PERSISTENCE:JAVADOC:185 | RollbackException | jakarta.persistence.RollbackException.RollbackException
(
String
)
|
Constructs a new RollbackException exception with the specified detail message.
| true |
| true |
PERSISTENCE:JAVADOC:186 | RollbackException | jakarta.persistence.RollbackException.RollbackException
(
String
, Throwable
)
|
Constructs a new RollbackException exception with the specified detail message and cause.
| true |
| true |
PERSISTENCE:JAVADOC:187 | RollbackException | jakarta.persistence.RollbackException.RollbackException
(
Throwable
)
|
Constructs a new RollbackException exception with the specified cause.
| true |
| true |
PERSISTENCE:JAVADOC:188 | String | jakarta.persistence.SecondaryTable.catalog
|
(Optional) The catalog of the table.
Defaults to the default catalog.
| true |
| true |
PERSISTENCE:JAVADOC:189 | String | jakarta.persistence.SecondaryTable.name
|
(Required) The name of the table.
| true |
| true |
PERSISTENCE:JAVADOC:190 | PrimaryKeyJoinColumn[] | 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:191 | String | jakarta.persistence.SecondaryTable.schema
|
(Optional) The schema of the table.
Defaults to the default schema for user.
| true |
| true |
PERSISTENCE:JAVADOC:192 | UniqueConstraint[] | 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:193 | SecondaryTable[] | jakarta.persistence.SecondaryTables.value
|
The secondary tables for an entity.
| true |
| true |
PERSISTENCE:JAVADOC:194 | int | jakarta.persistence.SequenceGenerator.allocationSize
|
(Optional) The amount to increment by when allocating sequence numbers from the sequence.
| true |
| true |
PERSISTENCE:JAVADOC:195 | int | jakarta.persistence.SequenceGenerator.initialValue
|
(Optional) The value from which the sequence object is to start generating.
| true |
| true |
PERSISTENCE:JAVADOC:196 | String | jakarta.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:197 | String | jakarta.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:198 | ColumnResult[] | jakarta.persistence.SqlResultSetMapping.columns
|
Specifies the result set mapping to scalar values.
| true |
| true |
PERSISTENCE:JAVADOC:199 | EntityResult[] | jakarta.persistence.SqlResultSetMapping.entities
|
Specifies the result set mapping to entities.
| true |
| true |
PERSISTENCE:JAVADOC:200 | String | jakarta.persistence.SqlResultSetMapping.name
|
The name given to the result set mapping, and used to refer to it in the methods of the Query API.
| true |
| true |
PERSISTENCE:JAVADOC:201 | SqlResultSetMapping[] | jakarta.persistence.SqlResultSetMappings.value
|
One or more SqlResultSetMapping.
| true |
| true |
PERSISTENCE:JAVADOC:202 | String | jakarta.persistence.Table.catalog
|
(Optional) The catalog of the table.
Defaults to the default catalog.
| true |
| true |
PERSISTENCE:JAVADOC:203 | String | jakarta.persistence.Table.name
|
(Optional) The name of the table.
Defaults to the entity name.
| true |
| true |
PERSISTENCE:JAVADOC:204 | String | jakarta.persistence.Table.schema
|
(Optional) The schema of the table.
Defaults to the default schema for user.
| true |
| true |
PERSISTENCE:JAVADOC:205 | UniqueConstraint[] | 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:206 | int | jakarta.persistence.TableGenerator.allocationSize
|
(Optional) The amount to increment by when allocating id numbers from the generator.
| true |
| true |
PERSISTENCE:JAVADOC:207 | String | jakarta.persistence.TableGenerator.catalog
|
(Optional) The catalog of the table.
Defaults to the default catalog.
| true |
| true |
PERSISTENCE:JAVADOC:208 | int | jakarta.persistence.TableGenerator.initialValue
|
(Optional) The initial value to be used when allocating id numbers from the generator.
| true |
| true |
PERSISTENCE:JAVADOC:209 | String | jakarta.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:210 | String | jakarta.persistence.TableGenerator.pkColumnName
|
(Optional) Name of the primary key column in the table.
Defaults to a provider-chosen name.
| true |
| true |
PERSISTENCE:JAVADOC:211 | String | jakarta.persistence.TableGenerator.pkColumnValue
|
(Optional) The primary key value in the generator table that distinguishes this set of generated values from others that may be stored in the table.
Defaults to a provider-chosen value to store in the primary key column of the generator table
| true |
| true |
PERSISTENCE:JAVADOC:212 | String | jakarta.persistence.TableGenerator.schema
|
(Optional) The schema of the table.
Defaults to the default schema for user.
| true |
| true |
PERSISTENCE:JAVADOC:213 | String | jakarta.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:214 | UniqueConstraint[] | 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:215 | String | jakarta.persistence.TableGenerator.valueColumnName
|
(Optional) Name of the column that stores the last value generated.
Defaults to a provider-chosen name.
| true |
| true |
PERSISTENCE:JAVADOC:216 | TemporalType | jakarta.persistence.Temporal.value
|
The type used in mapping java.util.Date or java.util.Calendar.
| true |
| true |
PERSISTENCE:JAVADOC:217 | TemporalType | jakarta.persistence.TemporalType.valueOf
(
String
)
|
| true |
| true |
PERSISTENCE:JAVADOC:218 | TemporalType[] | jakarta.persistence.TemporalType.values
|
| true |
| true |
PERSISTENCE:JAVADOC:219 | TransactionRequiredException | jakarta.persistence.TransactionRequiredException.TransactionRequiredException
|
Constructs a new TransactionRequiredException exception with null as its detail message.
| true |
| true |
PERSISTENCE:JAVADOC:220 | TransactionRequiredException | jakarta.persistence.TransactionRequiredException.TransactionRequiredException
(
String
)
|
Constructs a new TransactionRequiredException exception with the specified detail message.
| true |
| true |
PERSISTENCE:JAVADOC:221 | String[] | jakarta.persistence.UniqueConstraint.columnNames
|
(Required) An array of the column names that make up the constraint.
| true |
| false |
PERSISTENCE:JAVADOC:222 | byte[] | jakarta.persistence.spi.ClassTransformer.transform
(
ClassLoader
, String
, Class
, ProtectionDomain
, byte[]
)
|
Invoked when a class is being loaded or redefined.
The implementation of this method may transform the supplied class file and return a new replacement class file.
| true |
| true |
PERSISTENCE:JAVADOC:223 | byte[] | jakarta.persistence.spi.ClassTransformer.transform
(
ClassLoader
, String
, Class
, ProtectionDomain
, byte[]
)
throws
IllegalClassFormatException
| If the input does not represent a well-formed class file | true |
| true |
PERSISTENCE:JAVADOC:224 | EntityManagerFactory | jakarta.persistence.spi.PersistenceProvider.createContainerEntityManagerFactory
(
PersistenceUnitInfo
, Map
)
|
Called by the container when an jakarta.persistence.EntityManagerFactory is to be created.
| true |
| true |
PERSISTENCE:JAVADOC:225 | EntityManagerFactory | jakarta.persistence.spi.PersistenceProvider.createEntityManagerFactory
(
String
, Map
)
|
Called by Persistence class when an jakarta.persistence.EntityManagerFactory is to be created.
| true |
| true |
PERSISTENCE:JAVADOC:226 | void | jakarta.persistence.spi.PersistenceUnitInfo.addTransformer
(
ClassTransformer
)
|
Add a transformer supplied by the provider that will be called for every new class definition or class redefinition that gets loaded by the loader returned by the PersistenceUnitInfo#getClassLoader method.
The transformer has no effect on the result returned by the PersistenceUnitInfo#getNewTempClassLoader method. Classes are only transformed once within the same classloading scope, regardless of how many persistence units they may be a part of.
| true |
| true |
PERSISTENCE:JAVADOC:227 | boolean | jakarta.persistence.spi.PersistenceUnitInfo.excludeUnlistedClasses
|
Returns whether classes in the root of the persistence unit that have not been explicitly listed are to be included in the set of managed classes.
This value corresponds to the element in the persistence.xml file.
| true |
| true |
PERSISTENCE:JAVADOC:228 | ClassLoader | jakarta.persistence.spi.PersistenceUnitInfo.getClassLoader
|
Returns ClassLoader that the provider may use to load any classes, resources, or open URLs.
| true |
| true |
PERSISTENCE:JAVADOC:229 | List | jakarta.persistence.spi.PersistenceUnitInfo.getJarFileUrls
|
Returns a list of URLs for the jar files or exploded jar file directories that the persistence provider must examine for managed classes of the persistence unit.
Each URL corresponds to a named element in the persistence.xml file. A URL will either be a file: URL referring to a jar file or referring to a directory that contains an exploded jar file, or some other URL from which an InputStream in jar format can be obtained.
| true |
| true |
PERSISTENCE:JAVADOC:230 | DataSource | jakarta.persistence.spi.PersistenceUnitInfo.getJtaDataSource
|
Returns the JTA-enabled data source to be used by the persistence provider.
The data source corresponds to the element in the persistence.xml file or is provided at deployment or by the container.
| true |
| true |
PERSISTENCE:JAVADOC:231 | List | jakarta.persistence.spi.PersistenceUnitInfo.getManagedClassNames
|
Returns the list of the names of the classes that the persistence provider must add it to its set of managed classes.
Each name corresponds to a named element in the persistence.xml file.
| true |
| true |
PERSISTENCE:JAVADOC:232 | List | jakarta.persistence.spi.PersistenceUnitInfo.getMappingFileNames
|
Returns the list of mapping file names that the persistence provider must load to determine the mappings for the entity classes.
The mapping files must be in the standard XML mapping format, be uniquely named and be resource-loadable from the application classpath. This list will not include the orm.xml file if one was specified. Each mapping file name corresponds to a element in the persistence.xml file.
| true |
| true |
PERSISTENCE:JAVADOC:233 | ClassLoader | jakarta.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:234 | DataSource | jakarta.persistence.spi.PersistenceUnitInfo.getNonJtaDataSource
|
Returns the non-JTA-enabled data source to be used by the persistence provider for accessing data outside a JTA transaction.
The data source corresponds to the named element in the persistence.xml file or provided at deployment or by the container.
| true |
| true |
PERSISTENCE:JAVADOC:235 | String | jakarta.persistence.spi.PersistenceUnitInfo.getPersistenceProviderClassName
|
Returns the fully qualified name of the persistence provider implementation class.
Corresponds to the element in the persistence.xml file.
| true |
| true |
PERSISTENCE:JAVADOC:236 | String | jakarta.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:237 | URL | jakarta.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:238 | Properties | jakarta.persistence.spi.PersistenceUnitInfo.getProperties
|
Returns properties object.
Each property corresponds to a element in the persistence.xml file
| true |
| true |
PERSISTENCE:JAVADOC:239 | PersistenceUnitTransactionType | jakarta.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:240 | PersistenceUnitTransactionType | jakarta.persistence.spi.PersistenceUnitTransactionType.valueOf
(
String
)
|
| true |
| true |
PERSISTENCE:JAVADOC:241 | PersistenceUnitTransactionType[] | jakarta.persistence.spi.PersistenceUnitTransactionType.values
|
| true |
| true |