Record Class LockingClauseRequest

java.lang.Object

java.lang.Record

org.hibernate.dialect.lock.spi.LockingClauseRequest

@SPI
public record LockingClauseRequest(PessimisticLockKind lockKind, Timeout timeout, List<LockingClauseRequest.Target> targets)
extends Record

A complete, read-only request to render a pessimistic locking clause.

An empty targets list requests locking of the complete result set without an OF list. Otherwise, each target retains whether the database expects a table alias or a qualified column reference.

Since:

8.0

See Also:

• LockingClauseRenderer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	LockingClauseRequest.ColumnTarget	A qualified column-reference locking target.
static final record	LockingClauseRequest.TableTarget	A table-alias locking target.
static interface	LockingClauseRequest.Target	A structured target named by a locking clause.

Constructor Summary

Constructors

Constructor	Description
LockingClauseRequest(PessimisticLockKind lockKind, Timeout timeout, List<LockingClauseRequest.Target> targets)	Creates an immutable locking-clause request.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
PessimisticLockKind	lockKind()	Returns the value of the lockKind record component.
List<LockingClauseRequest.Target>	targets()	Returns the value of the targets record component.
Timeout	timeout()	Returns the value of the timeout record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

LockingClauseRequest

public LockingClauseRequest(PessimisticLockKind lockKind,
 Timeout timeout,
 List<LockingClauseRequest.Target> targets)

Creates an immutable locking-clause request.

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

lockKind

public PessimisticLockKind lockKind()

Returns the value of the lockKind record component.

Returns:

the value of the lockKind record component

timeout

public Timeout timeout()

Returns the value of the timeout record component.

Returns:

the value of the timeout record component

targets

public List<LockingClauseRequest.Target> targets()

Returns the value of the targets record component.

Returns:

the value of the targets record component