01 /*
02 * Copyright 2009-2012 the original author or authors.
03 *
04 * Licensed under the Apache License, Version 2.0 (the "License");
05 * you may not use this file except in compliance with the License.
06 * You may obtain a copy of the License at
07 *
08 * http://www.apache.org/licenses/LICENSE-2.0
09 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package griffon.transform;
18
19 import org.codehaus.groovy.transform.GroovyASTTransformationClass;
20
21 import java.lang.annotation.ElementType;
22 import java.lang.annotation.Retention;
23 import java.lang.annotation.RetentionPolicy;
24 import java.lang.annotation.Target;
25
26 /**
27 * <p>Annotates a class.</p>
28 *
29 * <p>When annotating a class it indicates that it will be able to
30 * execute code using the Application's threading facilities.</p>
31 * <p/>
32 * The following methods will be added to classes annotated with @ThreadingAware
33 * <ul>
34 * <li><code>public boolean isUIThread()</code></li>
35 * <li><code>public void execInsideUIAsync(Runnable runnable)</code></li>
36 * <li><code>public void execInsideUISync(Runnable runnable)</code></li>
37 * <li><code>public void execOutsideUI(Runnable runnable)</code></li>
38 * <li><code>public Future execFuture(ExecutorService executorService, Closure closure)</code></li>
39 * <li><code>public Future execFuture(Closure closure)</code></li>
40 * <li><code>public Future execFuture(ExecutorService executorService, Callable callable)</code></li>
41 * <li><code>public Future execFuture(Callable callable)</code></li>
42 * </ul>
43 *
44 * @author Andres Almiray
45 * @see griffon.core.ThreadingHandler
46 * @see org.codehaus.griffon.ast.ThreadingAwareASTTransformation
47 * @since 0.9.3
48 */
49 @Retention(RetentionPolicy.SOURCE)
50 @Target({ElementType.TYPE})
51 @GroovyASTTransformationClass("org.codehaus.griffon.ast.ThreadingAwareASTTransformation")
52 public @interface ThreadingAware {
53 }
|