ThreadingAware.java
01 /*
02  * SPDX-License-Identifier: Apache-2.0
03  *
04  * Copyright 2008-2017 the original author or authors.
05  *
06  * Licensed under the Apache License, Version 2.0 (the "License");
07  * you may not use this file except in compliance with the License.
08  * You may obtain a copy of the License at
09  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 package griffon.transform;
19 
20 import java.lang.annotation.Documented;
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  <p/>
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 &#064;ThreadingAware
33  <ul>
34  <li><code>public boolean isUIThread()</code></li>
35  <li><code>public void runInsideUIAsync(Runnable runnable)</code></li>
36  <li><code>public void runInsideUISync(Runnable runnable)</code></li>
37  <li><code>public void runOutsideUI(Runnable runnable)</code></li>
38  <li><code>public void runOutsideUIAsync(Runnable runnable)</code></li>
39  <li><code>public &lt;R&gt; Future&lt;R&gt; runFuture(ExecutorService executorService, Callable&lt;R&gt; callable)</code></li>
40  <li><code>public &lt;R&gt; Future&lt;R&gt; runFuture(Callable&lt;R&gt; callable)</code></li>
41  <li><code>public &lt;R&gt; R runInsideUISync(Callable&lt;R&gt; callable)</code></li>
42  <li><code>public &lt;R&gt; R runOutsideUI(Callable&lt;R&gt; callable)</code></li>
43  </ul>
44  *
45  @author Andres Almiray
46  @see griffon.core.threading.ThreadingHandler
47  @since 2.0.0
48  */
49 @Documented
50 @Retention(RetentionPolicy.SOURCE)
51 @Target({ElementType.TYPE})
52 public @interface ThreadingAware {
53 }