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.EARLY;
20 
21 import com.android.bedstead.harrier.DeviceState;
22 
23 import java.lang.annotation.ElementType;
24 import java.lang.annotation.Retention;
25 import java.lang.annotation.RetentionPolicy;
26 import java.lang.annotation.Target;
27 
28 /**
29  * Mark that a test method should only run on specified sdk versions.
30  *
31  * <p>Your test configuration may be configured so that this test is only run on a device with the
32  * given version. Otherwise, you can use {@link DeviceState} to ensure that the test is
33  * not run when the sdk version is not correct.
34  */
35 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
36 @Retention(RetentionPolicy.RUNTIME)
37 public @interface RequireSdkVersion {
min()38     int min() default 1;
max()39     int max() default Integer.MAX_VALUE;
reason()40     String reason() default "";
failureMode()41     FailureMode failureMode() default FailureMode.SKIP;
42 
43     /**
44      * Weight sets the order that annotations will be resolved.
45      *
46      * <p>Annotations with a lower weight will be resolved before annotations with a higher weight.
47      *
48      * <p>If there is an order requirement between annotations, ensure that the weight of the
49      * annotation which must be resolved first is lower than the one which must be resolved later.
50      *
51      * <p>Weight can be set to a {@link AnnotationRunPrecedence} constant, or to any {@link int}.
52      */
weight()53     int weight() default EARLY;
54 }
55