org.hrorm

Class Transactor

java.lang.Object

org.hrorm.Transactor

public class Transactor
extends Object

An aid for managing transactions.

Transactors save the trouble of writing blocks like

     Connection connection = null;
     try {
          connection = getConnection();

          // do something with the connection

          connection.commit();
     } catch (Exception ex){
         connection.rollback();
         throw ex;
     } finally {
         if (connection != null){
             connection.close();
         }
     }

Instead, you just write the part in the middle where you do something with the connection and the other parts are done for you.

Transactors will close the connection when done with their business.

Constructor Summary

Constructors

Constructor and Description
Transactor(Connection connection) Use this constructor for a use-once Transactor.
Transactor(Supplier<Connection> connectionSupplier) Use this constructor with a connection source, so that the Transactor can create a new connection each time it needs one.

Method Summary

Modifier and Type	Method and Description
void	runAndCommit(Consumer<Connection> action) Runs the specified action and either commits when complete or rolls back on an exception.
<RESULT> RESULT	runAndCommit(Function<Connection,RESULT> function) Runs the specified function and either commits when complete or rolls back on an exception.

Methods inherited from class java.lang.Object

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

Constructor Detail

Transactor

public Transactor(Connection connection)

Use this constructor for a use-once Transactor.

Parameters:

connection - the connection to use

Transactor

public Transactor(Supplier<Connection> connectionSupplier)

Use this constructor with a connection source, so that the Transactor can create a new connection each time it needs one.

Parameters:

connectionSupplier - A source for connections.

Method Detail

runAndCommit

public void runAndCommit(Consumer<Connection> action)

Runs the specified action and either commits when complete or rolls back on an exception. The connection used for this action will be closed when the action executes, whether it succeeds or fails.

Parameters:

action - the action to perform

runAndCommit

public <RESULT> RESULT runAndCommit(Function<Connection,RESULT> function)

Runs the specified function and either commits when complete or rolls back on an exception. The connection used for this action will be closed when the action executes, whether it succeeds or fails.

Type Parameters:

RESULT - the type of result the function returns

Parameters:

function - the function to run

Returns:

the result of the transaction