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.bedstead.harrier.annotations;
18 
19 import static com.android.bedstead.harrier.annotations.AnnotationRunPrecedence.MIDDLE;
20 
21 import com.android.bedstead.harrier.DeviceState;
22 import com.android.bedstead.harrier.annotations.meta.EnsureHasNoUserAnnotation;
23 
24 import java.lang.annotation.ElementType;
25 import java.lang.annotation.Retention;
26 import java.lang.annotation.RetentionPolicy;
27 import java.lang.annotation.Target;
28 
29 /**
30  * Mark that a test method should run on a device which has no secondary user that is not the
31  * instrumented user.
32  *
33  * <p>Your test configuration may be configured so that this test is only run on a device which
34  * has no secondary user that is not the current user. Otherwise, you can use {@link DeviceState}
35  * to ensure that the device enters the correct state for the method.
36  */
37 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
38 @Retention(RetentionPolicy.RUNTIME)
39 @EnsureHasNoUserAnnotation("android.os.usertype.full.SECONDARY")
40 public @interface EnsureHasNoSecondaryUser {
41     /**
42      * Weight sets the order that annotations will be resolved.
43      *
44      * <p>Annotations with a lower weight will be resolved before annotations with a higher weight.
45      *
46      * <p>If there is an order requirement between annotations, ensure that the weight of the
47      * annotation which must be resolved first is lower than the one which must be resolved later.
48      *
49      * <p>Weight can be set to a {@link AnnotationRunPrecedence} constant, or to any {@link int}.
50      */
weight()51     int weight() default MIDDLE;
52 }
53