Tor Norbye | 17dd669 | 2016-04-27 12:54:39 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2016 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 | 17dd669 | 2016-04-27 12:54:39 -0700 | [diff] [blame] | 18 | import static java.lang.annotation.ElementType.CONSTRUCTOR; |
| 19 | import static java.lang.annotation.ElementType.METHOD; |
Matthew Gharrity | cb43616 | 2017-07-17 17:18:00 -0700 | [diff] [blame] | 20 | import static java.lang.annotation.ElementType.PARAMETER; |
Tor Norbye | 17dd669 | 2016-04-27 12:54:39 -0700 | [diff] [blame] | 21 | import static java.lang.annotation.ElementType.TYPE; |
| 22 | import static java.lang.annotation.RetentionPolicy.SOURCE; |
| 23 | |
Jeff Sharkey | 910e081 | 2017-04-21 16:29:27 -0600 | [diff] [blame] | 24 | import java.lang.annotation.Retention; |
| 25 | import java.lang.annotation.Target; |
| 26 | |
Tor Norbye | 17dd669 | 2016-04-27 12:54:39 -0700 | [diff] [blame] | 27 | /** |
Jeff Sharkey | 910e081 | 2017-04-21 16:29:27 -0600 | [diff] [blame] | 28 | * Denotes that the annotated method can be called from any thread (e.g. it is |
| 29 | * "thread safe".) If the annotated element is a class, then all methods in the |
| 30 | * class can be called from any thread. |
Tor Norbye | 17dd669 | 2016-04-27 12:54:39 -0700 | [diff] [blame] | 31 | * <p> |
Jeff Sharkey | 910e081 | 2017-04-21 16:29:27 -0600 | [diff] [blame] | 32 | * The main purpose of this method is to indicate that you believe a method can |
| 33 | * be called from any thread; static tools can then check that nothing you call |
| 34 | * from within this method or class have more strict threading requirements. |
Tor Norbye | 17dd669 | 2016-04-27 12:54:39 -0700 | [diff] [blame] | 35 | * <p> |
| 36 | * Example: |
Jeff Sharkey | 910e081 | 2017-04-21 16:29:27 -0600 | [diff] [blame] | 37 | * |
| 38 | * <pre> |
| 39 | * <code> |
Tor Norbye | 17dd669 | 2016-04-27 12:54:39 -0700 | [diff] [blame] | 40 | * @AnyThread |
| 41 | * public void deliverResult(D data) { ... } |
Jeff Sharkey | 910e081 | 2017-04-21 16:29:27 -0600 | [diff] [blame] | 42 | * </code> |
| 43 | * </pre> |
Tor Norbye | 17dd669 | 2016-04-27 12:54:39 -0700 | [diff] [blame] | 44 | * |
Jeff Sharkey | 910e081 | 2017-04-21 16:29:27 -0600 | [diff] [blame] | 45 | * @memberDoc This method is safe to call from any thread. |
| 46 | * @hide |
Tor Norbye | 17dd669 | 2016-04-27 12:54:39 -0700 | [diff] [blame] | 47 | */ |
| 48 | @Retention(SOURCE) |
Matthew Gharrity | cb43616 | 2017-07-17 17:18:00 -0700 | [diff] [blame] | 49 | @Target({METHOD,CONSTRUCTOR,TYPE,PARAMETER}) |
Tor Norbye | 17dd669 | 2016-04-27 12:54:39 -0700 | [diff] [blame] | 50 | public @interface AnyThread { |
| 51 | } |