ThreadingAware.java
01 /*
02  * Copyright 2008-2015 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 package griffon.transform;
17 
18 import java.lang.annotation.Documented;
19 import java.lang.annotation.ElementType;
20 import java.lang.annotation.Retention;
21 import java.lang.annotation.RetentionPolicy;
22 import java.lang.annotation.Target;
23 
24 /**
25  <p>Annotates a class.</p>
26  <p/>
27  <p>When annotating a class it indicates that it will be able to
28  * execute code using the Application's threading facilities.</p>
29  <p/>
30  * The following methods will be added to classes annotated with &#064;ThreadingAware
31  <ul>
32  <li><code>public boolean isUIThread()</code></li>
33  <li><code>public void runInsideUIAsync(Runnable runnable)</code></li>
34  <li><code>public void runInsideUISync(Runnable runnable)</code></li>
35  <li><code>public void runOutsideUI(Runnable runnable)</code></li>
36  <li><code>public &lt;R&gt; Future&lt;R&gt; runFuture(ExecutorService executorService, Callable&lt;R&gt; callable)</code></li>
37  <li><code>public &lt;R&gt; Future&lt;R&gt; runFuture(Callable&lt;R&gt; callable)</code></li>
38  <li><code>public &lt;R&gt; R runInsideUISync(Callable&lt;R&gt; callable)</code></li>
39  <li><code>public &lt;R&gt; R runOutsideUI(Callable&lt;R&gt; callable)</code></li>
40  </ul>
41  *
42  @author Andres Almiray
43  @see griffon.core.threading.ThreadingHandler
44  @since 2.0.0
45  */
46 @Documented
47 @Retention(RetentionPolicy.SOURCE)
48 @Target({ElementType.TYPE})
49 public @interface ThreadingAware {
50 }