Class Transaction

java.lang.Object

com.pyranid.Transaction

@ThreadSafe
public final class Transaction
extends Object

Represents a database transaction.

Note that commit and rollback operations are controlled internally by Database.

Since:

1.0.0

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
void	addPostTransactionOperation(@NonNull Consumer<TransactionResult> postTransactionOperation)	Adds an operation to the list of operations to be executed when the transaction completes.
@NonNull Savepoint	createSavepoint()	Creates a transaction savepoint that can be rolled back to via rollback(Savepoint).
@NonNull List<@NonNull Consumer<TransactionResult>>	getPostTransactionOperations()	Gets an unmodifiable list of post-transaction operations.
@NonNull TransactionIsolation	getTransactionIsolation()	Get the isolation level for this transaction.
@NonNull Boolean	isRollbackOnly()	Should this transaction be rolled back upon completion?
@NonNull Boolean	removePostTransactionOperation(@NonNull Consumer<TransactionResult> postTransactionOperation)	Removes an operation from the list of operations to be executed when the transaction completes.
void	rollback(@NonNull Savepoint savepoint)	Rolls back to the provided transaction savepoint.
void	setRollbackOnly(@NonNull Boolean rollbackOnly)	Sets whether this transaction should be rolled back upon completion.
@NonNull String	toString()

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

toString

public @NonNull String toString()

Overrides:

toString in class Object

createSavepoint

public @NonNull Savepoint createSavepoint()

Creates a transaction savepoint that can be rolled back to via rollback(Savepoint).

Returns:

a transaction savepoint

rollback

public void rollback(@NonNull Savepoint savepoint)

Rolls back to the provided transaction savepoint.

Parameters:

savepoint - the savepoint to roll back to

isRollbackOnly

public @NonNull Boolean isRollbackOnly()

Should this transaction be rolled back upon completion?

Default value is false.

Returns:

true if this transaction should be rolled back, false otherwise

setRollbackOnly

public void setRollbackOnly(@NonNull Boolean rollbackOnly)

Sets whether this transaction should be rolled back upon completion.

Parameters:

rollbackOnly - whether to set this transaction to be rollback-only

addPostTransactionOperation

public void addPostTransactionOperation(@NonNull Consumer<TransactionResult> postTransactionOperation)

Adds an operation to the list of operations to be executed when the transaction completes.

Parameters:

postTransactionOperation - the post-transaction operation to add

removePostTransactionOperation

public @NonNull Boolean removePostTransactionOperation(@NonNull Consumer<TransactionResult> postTransactionOperation)

Removes an operation from the list of operations to be executed when the transaction completes.

Parameters:

postTransactionOperation - the post-transaction operation to remove

Returns:

true if the post-transaction operation was removed, false otherwise

getPostTransactionOperations

public @NonNull List<@NonNull Consumer<TransactionResult>> getPostTransactionOperations()

Gets an unmodifiable list of post-transaction operations.

To manipulate the list, use addPostTransactionOperation(Consumer) and removePostTransactionOperation(Consumer).

Returns:

the list of post-transaction operations

getTransactionIsolation

public @NonNull TransactionIsolation getTransactionIsolation()

Get the isolation level for this transaction.

Returns:

the isolation level