• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.FIRST;
20 
21 import java.lang.annotation.ElementType;
22 import java.lang.annotation.Retention;
23 import java.lang.annotation.RetentionPolicy;
24 import java.lang.annotation.Target;
25 
26 /**
27  * Mark that a test method should only be run on devices which are in headless system user mode.
28  *
29  * <p>You can guarantee that these methods only run on headless system user mode devices by
30  * using {@code DeviceState}.
31  */
32 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
33 @Retention(RetentionPolicy.RUNTIME)
34 public @interface RequireHeadlessSystemUserMode {
35 
36     /** The reason this test requires headless system user mode. */
reason()37     String reason();
38 
39     /**
40      * Weight sets the order that annotations will be resolved.
41      *
42      * <p>Annotations with a lower weight will be resolved before annotations with a higher weight.
43      *
44      * <p>If there is an order requirement between annotations, ensure that the weight of the
45      * annotation which must be resolved first is lower than the one which must be resolved later.
46      *
47      * <p>Weight can be set to a {@link AnnotationRunPrecedence} constant, or to any {@link int}.
48      */
weight()49     int weight() default FIRST;
50 }
51