Package io.micronaut.transaction.annotation

Enum Class TransactionalEventListener.TransactionPhase

java.lang.Object

java.lang.Enum<TransactionalEventListener.TransactionPhase>

io.micronaut.transaction.annotation.TransactionalEventListener.TransactionPhase

All Implemented Interfaces:

Serializable, Comparable<TransactionalEventListener.TransactionPhase>, Constable

Enclosing class:

TransactionalEventListener

public static enum TransactionalEventListener.TransactionPhase
extends Enum<TransactionalEventListener.TransactionPhase>

The phase at which a transactional event listener applies.

Since:

4.2

Author:

Stephane Nicoll, Juergen Hoeller, graemerocher

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AFTER_COMMIT	Fire the event after the commit has completed successfully.
AFTER_COMPLETION	Fire the event after the transaction has completed.
AFTER_ROLLBACK	Fire the event if the transaction has rolled back.
BEFORE_COMMIT	Fire the event before transaction commit.

Method Summary

Modifier and Type	Method	Description
static TransactionalEventListener.TransactionPhase	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TransactionalEventListener.TransactionPhase[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BEFORE_COMMIT

public static final TransactionalEventListener.TransactionPhase BEFORE_COMMIT

Fire the event before transaction commit.

See Also:

• TransactionSynchronization.beforeCommit(boolean)

AFTER_COMMIT

public static final TransactionalEventListener.TransactionPhase AFTER_COMMIT

Fire the event after the commit has completed successfully.

Note: This is a specialization of AFTER_COMPLETION and therefore executes in the same after-completion sequence of events, (and not in TransactionSynchronization.afterCommit()).

See Also:

• TransactionSynchronization.afterCompletion(io.micronaut.transaction.support.TransactionSynchronization.Status)
• TransactionSynchronization.Status.COMMITTED

AFTER_ROLLBACK

public static final TransactionalEventListener.TransactionPhase AFTER_ROLLBACK

Fire the event if the transaction has rolled back.

Note: This is a specialization of AFTER_COMPLETION and therefore executes in the same after-completion sequence of events.

See Also:

• TransactionSynchronization.afterCompletion(io.micronaut.transaction.support.TransactionSynchronization.Status)
• TransactionSynchronization.Status.ROLLED_BACK

AFTER_COMPLETION

public static final TransactionalEventListener.TransactionPhase AFTER_COMPLETION

Fire the event after the transaction has completed.

For more fine-grained events, use AFTER_COMMIT or AFTER_ROLLBACK to intercept transaction commit or rollback, respectively.

See Also:

• TransactionSynchronization.afterCompletion(io.micronaut.transaction.support.TransactionSynchronization.Status)

Method Details

values

public static TransactionalEventListener.TransactionPhase[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static TransactionalEventListener.TransactionPhase valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null