li.strolch.persistence.api

Enum TransactionCloseStrategy

java.lang.Object

java.lang.Enum<TransactionCloseStrategy>

li.strolch.persistence.api.TransactionCloseStrategy

All Implemented Interfaces:

Serializable, Comparable<TransactionCloseStrategy>

public enum TransactionCloseStrategy
extends Enum<TransactionCloseStrategy>

Defines what happens when a StrolchTransaction is closed. Strolch transactions are auto closeable which means when used in a try-with-resource block, then they are automatically closed. Depending on the use case, these transactions might write something to the DB, or only read the model, or even have to roll back, this is controlled by using these enums.

Author:

Robert von Burg

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMMIT The main close strategy type where changes are written to the model.
DO_NOTHING This is for read only transactions.
ROLLBACK In exceptional cases one might not want any changes to be written to the model, thus calling StrolchTransaction.rollbackOnClose() will have the transaction roll back all changes

Method Summary

Modifier and Type	Method and Description
abstract void	close(StrolchTransaction tx)
abstract boolean	isReadonly()
static TransactionCloseStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static TransactionCloseStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DO_NOTHING

public static final TransactionCloseStrategy DO_NOTHING

This is for read only transactions. If this strategy is used, then no changes will be written to the model. Use StrolchTransaction.doNothingOnClose() to simply close the transaction, releasing any resources

Note: When using this strategy, then the transaction will throw exceptions if you try to add commands to the transaction.

COMMIT

public static final TransactionCloseStrategy COMMIT

The main close strategy type where changes are written to the model. Use StrolchTransaction.commitOnClose() to commit any changes i.e. commands added to the transaction

ROLLBACK

public static final TransactionCloseStrategy ROLLBACK

In exceptional cases one might not want any changes to be written to the model, thus calling StrolchTransaction.rollbackOnClose() will have the transaction roll back all changes

Method Detail

values

public static TransactionCloseStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TransactionCloseStrategy c : TransactionCloseStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TransactionCloseStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

close

public abstract void close(StrolchTransaction tx)
                    throws StrolchException

Throws:

StrolchException

isReadonly

public abstract boolean isReadonly()