1 /* 2 * Copyright (C) 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.car; 18 19 import static java.lang.annotation.ElementType.CONSTRUCTOR; 20 import static java.lang.annotation.ElementType.FIELD; 21 import static java.lang.annotation.ElementType.METHOD; 22 import static java.lang.annotation.RetentionPolicy.SOURCE; 23 24 import java.lang.annotation.Retention; 25 import java.lang.annotation.Target; 26 27 /** 28 * Denotes that the annotated method or constructor should only be called on the common thread. 29 * 30 * <p> 31 * Example: 32 * 33 * <pre> 34 * <code> 35 * @CommonThread 36 * public void doWork() { ... } 37 * </code> 38 * </pre> 39 * 40 * @memberDoc This method must be called on the common car thread. This is typically the thread 41 * which the {@link CarServiceUtils#getCommonHandlerThread()} is bound to. 42 */ 43 @Retention(SOURCE) 44 @Target({METHOD, CONSTRUCTOR, FIELD}) 45 public @interface CommonThread { 46 } 47