Home | History | Annotate | Download | only in annotation
      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 androidx.annotation;
     17 
     18 import static java.lang.annotation.ElementType.CONSTRUCTOR;
     19 import static java.lang.annotation.ElementType.METHOD;
     20 import static java.lang.annotation.ElementType.PARAMETER;
     21 import static java.lang.annotation.ElementType.TYPE;
     22 import static java.lang.annotation.RetentionPolicy.CLASS;
     23 
     24 import java.lang.annotation.Documented;
     25 import java.lang.annotation.Retention;
     26 import java.lang.annotation.Target;
     27 
     28 /**
     29  * Denotes that the annotated method can be called from any thread (e.g. it is "thread safe".)
     30  * If the annotated element is a class, then all methods in the class can be called
     31  * from any thread.
     32  * <p>
     33  * The main purpose of this method is to indicate that you believe a method can be called
     34  * from any thread; static tools can then check that nothing you call from within this method
     35  * or class have more strict threading requirements.
     36  * <p>
     37  * Example:
     38  * <pre><code>
     39  *  &#64;AnyThread
     40  *  public void deliverResult(D data) { ... }
     41  * </code></pre>
     42  */
     43 @Documented
     44 @Retention(CLASS)
     45 @Target({METHOD,CONSTRUCTOR,TYPE,PARAMETER})
     46 public @interface AnyThread {
     47 }
     48