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 
17 package com.android.bedstead.contentsuggestions.annotations;
18 
19 import static com.android.bedstead.harrier.UserType.INSTRUMENTED_USER;
20 import static com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence.LATE;
21 
22 import com.android.bedstead.harrier.UserType;
23 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence;
24 import com.android.bedstead.harrier.annotations.UsesAnnotationExecutor;
25 
26 import java.lang.annotation.ElementType;
27 import java.lang.annotation.Retention;
28 import java.lang.annotation.RetentionPolicy;
29 import java.lang.annotation.Target;
30 
31 /**
32  * Mark that a test method requires the default content suggestions service to be enabled.
33  *
34  * <p>You can use {@code DeviceState} to ensure that the device enters
35  * the correct state for the method.
36  */
37 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
38 @Retention(RetentionPolicy.RUNTIME)
39 @UsesAnnotationExecutor(UsesAnnotationExecutor.CONTENT_SUGGESTIONS)
40 public @interface EnsureDefaultContentSuggestionsServiceEnabled {
41 
42     /** Which user type the service must be enabled on. */
onUser()43     UserType onUser() default INSTRUMENTED_USER;
44 
45      /**
46      * Priority sets the order that annotations will be resolved.
47      *
48      * <p>Annotations with a lower priority will be resolved before annotations with a higher
49      * priority.
50      *
51      * <p>If there is an order requirement between annotations, ensure that the priority of the
52      * annotation which must be resolved first is lower than the one which must be resolved later.
53      *
54      * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}.
55      */
priority()56     int priority() default LATE;
57 }
58