Record Class LockingSqlRewriteResult

java.lang.Object

java.lang.Record

org.hibernate.dialect.lock.spi.LockingSqlRewriteResult

Record Components:

sql - rewritten SQL for LockingSqlRewriteResult.Outcome.APPLIED, otherwise the unchanged input SQL

outcome - semantic outcome of the rewrite attempt

@SPI
public record LockingSqlRewriteResult(String sql, LockingSqlRewriteResult.Outcome outcome)
extends Record

The immutable outcome of applying pessimistic locking to already-rendered SQL.

Rewriters must distinguish an inapplicable request from one they cannot safely fulfill. Hibernate may use LockingSqlRewriteResult.Outcome.UNSUPPORTED when deciding whether to perform follow-on locking; it must not interpret that outcome as successful locking.

Since:

8.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LockingSqlRewriteResult.Outcome	Classification of the rewrite outcome.

Constructor Summary

Constructors

Constructor	Description
LockingSqlRewriteResult(String sql, LockingSqlRewriteResult.Outcome outcome)	Creates a rewrite result.

Method Summary

Modifier and Type	Method	Description
static LockingSqlRewriteResult	applied(String sql)	Creates a result for a successfully applied rewrite.
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.
static LockingSqlRewriteResult	notApplicable(String sql)	Creates a result for a request which requires no SQL rewrite.
LockingSqlRewriteResult.Outcome	outcome()	Returns the value of the outcome record component.
String	sql()	Returns the value of the sql record component.
final String	toString()	Returns a string representation of this record class.
static LockingSqlRewriteResult	unsupported(String sql)	Creates a result for a request which cannot be applied safely.

Methods inherited from class Object

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

Constructor Details

LockingSqlRewriteResult

public LockingSqlRewriteResult(String sql,
 LockingSqlRewriteResult.Outcome outcome)

Creates a rewrite result.

Method Details

applied

public static LockingSqlRewriteResult applied(String sql)

Creates a result for a successfully applied rewrite.

notApplicable

public static LockingSqlRewriteResult notApplicable(String sql)

Creates a result for a request which requires no SQL rewrite.

unsupported

public static LockingSqlRewriteResult unsupported(String sql)

Creates a result for a request which cannot be applied safely.

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

outcome

public LockingSqlRewriteResult.Outcome outcome()

Returns the value of the outcome record component.

Returns:

the value of the outcome record component