Home | History | Annotate | Download | only in annotation
      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 
     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 
     23 import android.os.Looper;
     24 
     25 import java.lang.annotation.Retention;
     26 import java.lang.annotation.Target;
     27 
     28 /**
     29  * Denotes that the annotated method or constructor should only be called on the
     30  * UI thread. If the annotated element is a class, then all methods in the class
     31  * should be called on the UI thread.
     32  * <p>
     33  * Example:
     34  *
     35  * <pre>
     36  * <code>
     37  *  &#64;UiThread
     38  *  public abstract void setText(@NonNull String text) { ... }
     39  * </code>
     40  * </pre>
     41  *
     42  * @memberDoc This method must be called on the thread that originally created
     43  *            this UI element. This is typically the
     44  *            {@linkplain Looper#getMainLooper() main thread} of your app.
     45  * @hide
     46  */
     47 @Retention(SOURCE)
     48 @Target({METHOD,CONSTRUCTOR,TYPE})
     49 public @interface UiThread {
     50 }
     51