|
|||||||||||||||||||
Source file | Conditionals | Statements | Methods | TOTAL | |||||||||||||||
TransactionCompleted.java | - | - | - | - |
|
1 | package org.jboss.cache.notifications.annotation; | |
2 | ||
3 | import java.lang.annotation.ElementType; | |
4 | import java.lang.annotation.Retention; | |
5 | import java.lang.annotation.RetentionPolicy; | |
6 | import java.lang.annotation.Target; | |
7 | ||
8 | /** | |
9 | * This annotation should be used on methods that need to be notified when the cache is called to participate in a transaction and | |
10 | * the transaction completes, either with a commit or a rollback. | |
11 | * <p/> | |
12 | * Methods annotated with this annotation should accept a single | |
13 | * parameter, a {@link org.jboss.cache.notifications.event.TransactionCompletedEvent} otherwise a {@link org.jboss.cache.notifications.IncorrectCacheListenerException} | |
14 | * will be thrown when registering your listener. | |
15 | * <p/> | |
16 | * Note that methods marked with this annotation will only be fired <i>after the fact</i>, i.e., your method will never be | |
17 | * called with {@link org.jboss.cache.notifications.event.Event#isPre()} being set to <tt>true</tt>. | |
18 | * | |
19 | * @author <a href="mailto:manik@jboss.org">Manik Surtani</a> | |
20 | * @see CacheListener | |
21 | * @since 2.0.0 | |
22 | */ | |
23 | // ensure this annotation is available at runtime. | |
24 | @Retention(RetentionPolicy.RUNTIME) | |
25 | // ensure that this annotation is applied to classes. | |
26 | @Target(ElementType.METHOD) | |
27 | public @interface TransactionCompleted | |
28 | { | |
29 | } |
|