Module jakarta.persistence

Package jakarta.persistence

Enum Class PessimisticLockScope

java.lang.Object

java.lang.Enum<PessimisticLockScope>

jakarta.persistence.PessimisticLockScope

All Implemented Interfaces:

FindOption, LockOption, RefreshOption, Serializable, Comparable<PessimisticLockScope>, Constable

public enum PessimisticLockScope
extends Enum<PessimisticLockScope>
implements FindOption, RefreshOption, LockOption

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

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
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.
NORMAL	This value defines the default behavior for pessimistic locking.

Method Summary

Modifier and Type	Method	Description
static PessimisticLockScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PessimisticLockScope[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NORMAL

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.

EXTENDED

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.

Method Details

values

public static PessimisticLockScope[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PessimisticLockScope valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null