• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 2021 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 
17 package com.android.server.nearby.common.eventloop;
18 
19 import static java.lang.annotation.ElementType.CONSTRUCTOR;
20 import static java.lang.annotation.ElementType.METHOD;
21 import static java.lang.annotation.ElementType.TYPE;
22 import static java.lang.annotation.RetentionPolicy.CLASS;
23 
24 import androidx.annotation.AnyThread;
25 import androidx.annotation.BinderThread;
26 import androidx.annotation.UiThread;
27 import androidx.annotation.WorkerThread;
28 
29 import java.lang.annotation.Retention;
30 import java.lang.annotation.Target;
31 
32 /**
33  * A collection of threading annotations relating to EventLoop. These should be used in conjunction
34  * with {@link UiThread}, {@link BinderThread}, {@link WorkerThread}, and {@link AnyThread}.
35  */
36 public class Annotations {
37 
38     /**
39      * Denotes that the annotated method or constructor should only be called on the EventLoop
40      * thread.
41      */
42     @Retention(CLASS)
43     @Target({METHOD, CONSTRUCTOR, TYPE})
44     public @interface EventThread {
45     }
46 
47     /** Denotes that the annotated method or constructor should only be called on a Network
48      * thread. */
49     @Retention(CLASS)
50     @Target({METHOD, CONSTRUCTOR, TYPE})
51     public @interface NetworkThread {
52     }
53 }
54