Class TransactionalState

java.lang.Object

com.github.robtimus.os.windows.registry.TransactionalState

public abstract sealed class TransactionalState
extends Object

The possible transactional states.

Author:

Rob Spoor

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TransactionalState.Action<X extends Throwable>	A transactional action.
static interface	TransactionalState.Callable<R, X extends Throwable>	A transactional action that returns a result.

Method Summary

Modifier and Type	Method	Description
<R, X extends Throwable> R	call(TransactionalState.Callable<? extends R, X> action)	Runs an action.
static TransactionalState	mandatory()	Returns a transactional state that will cause an exception to be thrown if no current transaction exists.
static TransactionalState	never()	Returns a transactional state that will cause an exception to be thrown if a current transaction exists.
static TransactionalState	notSupported()	Returns a transactional state that will not use any transaction.
static TransactionalState	required(TransactionOption... options)	Returns a transactional state that will use the current transaction if one exists, or create a new one otherwise.
static TransactionalState	requiresNew(TransactionOption... options)	Returns a transactional state that will create a new transaction.
<X extends Throwable> void	run(TransactionalState.Action<X> action)	Runs an action.
static TransactionalState	supports()	Returns a transactional state that will use the current transaction if one exists, or no transaction otherwise.

Methods inherited from class Object

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

Method Details

mandatory

public static TransactionalState mandatory()

Returns a transactional state that will cause an exception to be thrown if no current transaction exists.

Returns:

A transactional state that will cause an exception to be thrown if no current transaction exists.

required

public static TransactionalState required(TransactionOption... options)

Returns a transactional state that will use the current transaction if one exists, or create a new one otherwise.

Parameters:

options - The options to use when creating a new transaction. They are ignored if a current transaction exists.

Returns:

A transactional state that will use the current transaction if one exists, or create a new one otherwise.

Throws:

NullPointerException - If any of the given options is null.

IllegalStateException - If the given options contain different occurrences for the same option, e.g. multiple timeouts.

requiresNew

public static TransactionalState requiresNew(TransactionOption... options)

Returns a transactional state that will create a new transaction.

Parameters:

options - The options to use when creating a new transaction.

Returns:

A transactional state that will create a new transaction.

Throws:

NullPointerException - If any of the given options is null.

IllegalStateException - If the given options contain different occurrences for the same option, e.g. multiple timeouts.

supports

public static TransactionalState supports()

Returns a transactional state that will use the current transaction if one exists, or no transaction otherwise.

Returns:

A transactional state that will use the current transaction if one exists, or no transaction otherwise.

notSupported

public static TransactionalState notSupported()

Returns a transactional state that will not use any transaction. If a current transaction exists it will be ignored.

Returns:

A transactional state that will not use any transaction.

never

public static TransactionalState never()

Returns a transactional state that will cause an exception to be thrown if a current transaction exists.

Returns:

A transactional state that will cause an exception to be thrown if a current transaction exists.

run

public <X extends Throwable> void run(TransactionalState.Action<X> action)
                               throws X

Runs an action.

Type Parameters:

X - The type of exception thrown by the action.

Parameters:

action - The action to run.

Throws:

NullPointerException - If the given action is null.

UnsupportedOperationException - If the current Windows version does not support transactions.

TransactionException - If a required transaction could not be created (optional).

TransactionRequiredException - If a mandatory transactional state is used without a current transaction (optional).

TransactionNotAllowedException - If a transactional state that does not allow transactions is used with a current transaction (optional).

X - If the action completes with an exception.

See Also:

• RegistryFeature.TRANSACTIONS

call

public <R, X extends Throwable> R call(TransactionalState.Callable<? extends R, X> action)
                                throws X

Runs an action.

Type Parameters:

R - The action's result type.

X - The type of exception thrown by the action.

Parameters:

action - The action to run.

Returns:

The result of the action.

Throws:

NullPointerException - If the given action is null.

UnsupportedOperationException - If the current Windows version does not support transactions.

TransactionException - If a required transaction could not be created (optional).

TransactionRequiredException - If a mandatory transactional state is used without a current transaction (optional).

TransactionNotAllowedException - If a transactional state that does not allow transactions is used with a current transaction (optional).

X - If the action completes with an exception.

See Also:

• RegistryFeature.TRANSACTIONS