Record Class FollowOnLockingRequest

java.lang.Object

java.lang.Record

org.hibernate.dialect.lock.spi.FollowOnLockingRequest

Record Components:

sql - the completed SQL considered for execution

statementShape - known structural characteristics of the SQL statement

pagination - effective pagination characteristics

lockKind - requested pessimistic lock kind

timeout - effective lock timeout

scope - requested pessimistic lock scope

rawSqlRewriteOutcome - outcome of any already-rendered SQL rewrite

@SPI
public record FollowOnLockingRequest(String sql, FollowOnLockingRequest.StatementShape statementShape, FollowOnLockingRequest.Pagination pagination, PessimisticLockKind lockKind, Timeout timeout, PessimisticLockScope scope, LockingSqlRewriteResult.Outcome rawSqlRewriteOutcome)
extends Record

The immutable facts used to decide whether a completed SQL statement requires follow-on locking.

Hibernate creates this request after SQL rendering and any raw-SQL locking attempt. A FollowOnLockingPolicy should make its decision only from these stable facts and must not retain the request.

Since:

8.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FollowOnLockingRequest.Pagination	Effective pagination characteristics of the completed statement.
static final record	FollowOnLockingRequest.StatementShape	Known structural characteristics of the completed statement.

Constructor Summary

Constructors

Constructor	Description
FollowOnLockingRequest(String sql, FollowOnLockingRequest.StatementShape statementShape, FollowOnLockingRequest.Pagination pagination, PessimisticLockKind lockKind, Timeout timeout, PessimisticLockScope scope, LockingSqlRewriteResult.Outcome rawSqlRewriteOutcome)	Creates a complete follow-on locking 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.
FollowOnLockingRequest.Pagination	pagination()	Returns the value of the pagination record component.
LockingSqlRewriteResult.Outcome	rawSqlRewriteOutcome()	Returns the value of the rawSqlRewriteOutcome record component.
PessimisticLockScope	scope()	Returns the value of the scope record component.
String	sql()	Returns the value of the sql record component.
FollowOnLockingRequest.StatementShape	statementShape()	Returns the value of the statementShape 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

FollowOnLockingRequest

public FollowOnLockingRequest(String sql,
 FollowOnLockingRequest.StatementShape statementShape,
 FollowOnLockingRequest.Pagination pagination,
 PessimisticLockKind lockKind,
 Timeout timeout,
 PessimisticLockScope scope,
 LockingSqlRewriteResult.Outcome rawSqlRewriteOutcome)

Creates a complete follow-on locking 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.

sql

public String sql()

Returns the value of the sql record component.

Returns:

the value of the sql record component

statementShape

public FollowOnLockingRequest.StatementShape statementShape()

Returns the value of the statementShape record component.

Returns:

the value of the statementShape record component

pagination

public FollowOnLockingRequest.Pagination pagination()

Returns the value of the pagination record component.

Returns:

the value of the pagination record component

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

scope

public PessimisticLockScope scope()

Returns the value of the scope record component.

Returns:

the value of the scope record component

rawSqlRewriteOutcome

public LockingSqlRewriteResult.Outcome rawSqlRewriteOutcome()

Returns the value of the rawSqlRewriteOutcome record component.

Returns:

the value of the rawSqlRewriteOutcome record component