Top Description Fields Constructors Methods
jakarta.persistence

public final Enum PessimisticLockScope

extends Enum<PessimisticLockScope>
implements FindOption, RefreshOption, LockOption
Class Inheritance
All Implemented Interfaces
jakarta.persistence.LockOption, jakarta.persistence.RefreshOption, jakarta.persistence.FindOption

Defines the values of the jakarta.persistence.lock.scope property for pessimistic locking. This property may be passed as an argument to the methods of the EntityManager, Query, and TypedQuery interfaces that allow lock modes to be specified or used with the NamedQuery annotation.
Since
2.0

Field Summary

Modifier and TypeField and Description
public static final PessimisticLockScope
EXTENDED

In addition to the locking behavior specified for NORMAL, element collections and relationships owned by the entity that are contained in join tables are locked if the property jakarta.persistence.lock.scope is specified with a value of PessimisticLockScope#EXTENDED.

public static final PessimisticLockScope
NORMAL

This value defines the default behavior for pessimistic locking.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static PessimisticLockScope
public static PessimisticLockScope[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

EXTENDEDback to summary
public static final PessimisticLockScope EXTENDED

In addition to the locking behavior specified for NORMAL, element collections and relationships owned by the entity that are contained in join tables are locked if the property jakarta.persistence.lock.scope is specified with a value of PessimisticLockScope#EXTENDED. The state of entities referenced by such relationships is not locked (unless those entities are explicitly locked). Locking such a relationship or element collection generally locks only the rows in the join table or collection table for that relationship or collection. This means that phantoms are possible.

NORMALback to summary
public static final PessimisticLockScope NORMAL

This value defines the default behavior for pessimistic locking.

The persistence provider must lock the database row(s) that correspond to the non-collection-valued persistent state of that instance. If a joined inheritance strategy is used, or if the entity is otherwise mapped to a secondary table, this entails locking the row(s) for the entity instance in the additional table(s). Entity relationships for which the locked entity contains the foreign key will also be locked, but not the state of the referenced entities (unless those entities are explicitly locked). Element collections and relationships for which the entity does not contain the foreign key (such as relationships that are mapped to join tables or unidirectional one-to-many relationships for which the target entity contains the foreign key) will not be locked by default.

Constructor Detail

PessimisticLockScopeback to summary
private PessimisticLockScope()

Method Detail

valueOfback to summary
public static PessimisticLockScope valueOf(String name)
valuesback to summary
public static PessimisticLockScope[] values()