Module litebridge.orm

Package org.litebridgedb.orm.api.tx

Class TransactionContextTerminal

java.lang.Object

org.litebridgedb.orm.api.tx.TransactionContextTerminal

Direct Known Subclasses:

TransactionContext

public sealed class TransactionContextTerminal
extends Object
permits TransactionContext

Represents the terminal stage of a transactional context, providing core methods for configuring and managing transactions. This class defines basic transactional operations such as setting the transaction as read-only, specifying isolation levels, and handling the lifecycle of transactions.

This is a sealed class, permitting only specific subclasses to extend it.

Field Summary

Fields

Modifier and Type	Field	Description
protected Isolation	isolation
protected boolean	readOnly
protected final TransactionManager	transactionManager

Method Summary

Modifier and Type	Method	Description
Transaction	begin()	Begins a new transaction for the current thread.
void	execute(Runnable runnable)	Executes a given Runnable within the context of a transaction.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

transactionManager

protected final TransactionManager transactionManager

readOnly

protected boolean readOnly

isolation

protected Isolation isolation

Method Details

begin

public Transaction begin()

Begins a new transaction for the current thread.

This method should be called before performing operations that need to be executed within a transactional context. It ensures that subsequent database interactions are part of the same transaction until it is either committed or rolled back.

This method may be called multiple times (nested).

Returns:

a Transaction auto-closeable, suitable for use in a try-with-resources statement.

Throws:

TransactionException - if an error occurs during starting the transaction

execute

public void execute(Runnable runnable)

Executes a given Runnable within the context of a transaction.

This method begins a new transaction, executes the provided Runnable, and commits the transaction if no exception occurs. In case of an exception, the transaction is rolled back, and a TransactionException is thrown.

Parameters:

runnable - the Runnable containing the operations to be executed within the transactional context

Throws:

TransactionException - if an error occurs during execution or if the transaction is rolled back due to an exception