com.github.susom.database

Class DbRun

java.lang.Object

com.github.susom.database.DbRun

All Implemented Interfaces:

Transaction

public abstract class DbRun
extends Object
implements Transaction

Abstract base class for a block of runnable code using a transacted Database.

Author:

garricko

Constructor Summary

Constructors

Constructor and Description
DbRun()

Method Summary

Modifier and Type	Method and Description
boolean	isRollbackOnError()
boolean	isRollbackOnly()
abstract void	run(javax.inject.Provider<Database> db) Implement this method to provide a block of code that uses the provided database and is transacted.
void	setRollbackOnError(boolean rollbackOnError) By default the transaction behavior (whether commit() or rollback() is called) after run() is specified by how this code block is invoked.
void	setRollbackOnException(boolean rollbackOnError) Deprecated. use setRollbackOnError() instead
void	setRollbackOnly(boolean rollbackOnly) If your code inside run() decides for some reason the transaction should rollback rather than commit, use this method.

Methods inherited from class java.lang.Object

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

Constructor Detail

DbRun

public DbRun()

Method Detail

run

public abstract void run(javax.inject.Provider<Database> db)
                  throws Exception

Implement this method to provide a block of code that uses the provided database and is transacted. Whether the transaction will commit or rollback is typically controlled by the code that invokes this method. This behavior can sometimes be altered by calling the appropriate set*() methods on this class.

If a Throwable is thrown from this method, it will be caught, wrapped in a DatabaseException (if it is not already one), and then propagated.

Throws:

Exception

isRollbackOnError

public boolean isRollbackOnError()

Specified by:

isRollbackOnError in interface Transaction

Returns:

whether this code block has requested rollback upon a Throwable being thrown from the run(Provider) method - this only reflects what was requested by calling setRollbackOnError(boolean), which is not necessarily what will actually happen

setRollbackOnException

@Deprecated
public void setRollbackOnException(boolean rollbackOnError)

Deprecated. use setRollbackOnError() instead

setRollbackOnError

public void setRollbackOnError(boolean rollbackOnError)

By default the transaction behavior (whether commit() or rollback() is called) after run() is specified by how this code block is invoked. For example, see DatabaseProvider#transactCommitOnly(DbRun), DatabaseProvider#transactRollbackOnly(DbRun), and DatabaseProvider#transactRollbackOnError(DbRun). Depending on the context, you may be able to request different behavior using this method. See documentation of these transact*() methods for details.

Specified by:

setRollbackOnError in interface Transaction

Parameters:

rollbackOnError - true to rollback after errors; false to commit or rollback based on the other settings

See Also:

DatabaseProvider.transact(DbCodeTx)

isRollbackOnly

public boolean isRollbackOnly()

Specified by:

isRollbackOnly in interface Transaction

Returns:

whether this code block has requested unconditional rollback - this only reflects what was requested by calling setRollbackOnly(boolean), which is not necessarily what will actually happen

setRollbackOnly

public void setRollbackOnly(boolean rollbackOnly)

If your code inside run() decides for some reason the transaction should rollback rather than commit, use this method.

By default the transaction behavior (whether commit() or rollback() is called) after run() is specified by how this code block is invoked. For example, see DatabaseProvider#transactCommitOnly(DbRun), DatabaseProvider#transactRollbackOnly(DbRun), and DatabaseProvider#transactRollbackOnError(DbRun). Depending on the context, you may be able to request different behavior using this method. See documentation of these transact*() methods for details.

Specified by:

setRollbackOnly in interface Transaction

Parameters:

rollbackOnly - true to request an unconditional rollback; false to commit or rollback based on the other settings

See Also:

DatabaseProvider.transact(DbCodeTx)