1 /* 2 * Copyright (C) 2022 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 com.android.bedstead.multiuser.annotations 17 18 import com.android.bedstead.harrier.UserType 19 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence 20 import com.android.bedstead.harrier.annotations.UsesAnnotationExecutor 21 22 /** 23 * Mark that a particular user type is the "other" user. 24 * 25 * 26 * This user can then be accessed using `DeviceState#otherUser`. 27 */ 28 @Target( 29 AnnotationTarget.FUNCTION, 30 AnnotationTarget.PROPERTY_GETTER, 31 AnnotationTarget.PROPERTY_SETTER, 32 AnnotationTarget.ANNOTATION_CLASS, 33 AnnotationTarget.CLASS 34 ) 35 @Retention( 36 AnnotationRetention.RUNTIME 37 ) 38 @UsesAnnotationExecutor(UsesAnnotationExecutor.MULTI_USER) 39 annotation class OtherUser( 40 val value: UserType, 41 /** 42 * Priority sets the order that annotations will be resolved. 43 * 44 * 45 * Annotations with a lower priority will be resolved before annotations with a higher 46 * priority. 47 * 48 * 49 * If there is an order requirement between annotations, ensure that the priority of the 50 * annotation which must be resolved first is lower than the one which must be resolved later. 51 * 52 * 53 * Priority can be set to a [AnnotationPriorityRunPrecedence] constant, or to any [int]. 54 */ 55 val priority: Int = AnnotationPriorityRunPrecedence.MIDDLE 56 ) 57