Tor Norbye | f8b8336 | 2015-03-10 19:15:27 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2015 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 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 android.annotation; |
| 17 | |
Tor Norbye | f8b8336 | 2015-03-10 19:15:27 -0700 | [diff] [blame] | 18 | import static java.lang.annotation.ElementType.CONSTRUCTOR; |
| 19 | import static java.lang.annotation.ElementType.METHOD; |
| 20 | import static java.lang.annotation.ElementType.TYPE; |
| 21 | import static java.lang.annotation.RetentionPolicy.SOURCE; |
| 22 | |
Jeff Sharkey | 6503bd8 | 2017-04-19 23:24:18 -0600 | [diff] [blame] | 23 | import android.os.Looper; |
| 24 | |
Jeff Sharkey | 910e081 | 2017-04-21 16:29:27 -0600 | [diff] [blame] | 25 | import java.lang.annotation.Retention; |
| 26 | import java.lang.annotation.Target; |
| 27 | |
Tor Norbye | f8b8336 | 2015-03-10 19:15:27 -0700 | [diff] [blame] | 28 | /** |
| 29 | * Denotes that the annotated method should only be called on the main thread. |
Jeff Sharkey | 6503bd8 | 2017-04-19 23:24:18 -0600 | [diff] [blame] | 30 | * If the annotated element is a class, then all methods in the class should be |
| 31 | * called on the main thread. |
Tor Norbye | f8b8336 | 2015-03-10 19:15:27 -0700 | [diff] [blame] | 32 | * <p> |
| 33 | * Example: |
Jeff Sharkey | 6503bd8 | 2017-04-19 23:24:18 -0600 | [diff] [blame] | 34 | * |
| 35 | * <pre> |
| 36 | * <code> |
Tor Norbye | f8b8336 | 2015-03-10 19:15:27 -0700 | [diff] [blame] | 37 | * @MainThread |
| 38 | * public void deliverResult(D data) { ... } |
Jeff Sharkey | 6503bd8 | 2017-04-19 23:24:18 -0600 | [diff] [blame] | 39 | * </code> |
| 40 | * </pre> |
Tor Norbye | f8b8336 | 2015-03-10 19:15:27 -0700 | [diff] [blame] | 41 | * |
Jeff Sharkey | 6503bd8 | 2017-04-19 23:24:18 -0600 | [diff] [blame] | 42 | * @memberDoc This method must be called from the |
| 43 | * {@linkplain Looper#getMainLooper() main thread} of your app. |
| 44 | * @hide |
Tor Norbye | f8b8336 | 2015-03-10 19:15:27 -0700 | [diff] [blame] | 45 | */ |
| 46 | @Retention(SOURCE) |
| 47 | @Target({METHOD,CONSTRUCTOR,TYPE}) |
| 48 | public @interface MainThread { |
Jeff Sharkey | 6503bd8 | 2017-04-19 23:24:18 -0600 | [diff] [blame] | 49 | } |