• 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.Repeatable;
23 import java.lang.annotation.Retention;
24 import java.lang.annotation.RetentionPolicy;
25 import java.lang.annotation.Target;
26 
27 /**
28  * Mark that a test method should run only when the device does not have a given feature.
29  *
30  * <p>You can guarantee that these methods do not run on devices with the feature by using {@code
31  * DeviceState}.
32  *
33  * <p>By default the test will be skipped if the feature is available. If you'd rather the test fail
34  * then use {@code failureMode = FailureMode.FAIL}.
35  */
36 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
37 @Retention(RetentionPolicy.RUNTIME)
38 @Repeatable(RequireDoesNotHaveFeatureGroup.class)
39 public @interface RequireDoesNotHaveFeature {
value()40     String value();
41 
failureMode()42     FailureMode failureMode() default FailureMode.SKIP;
43 
44     /**
45      * Weight sets the order that annotations will be resolved.
46      *
47      * <p>Annotations with a lower weight will be resolved before annotations with a higher weight.
48      *
49      * <p>If there is an order requirement between annotations, ensure that the weight of the
50      * annotation which must be resolved first is lower than the one which must be resolved later.
51      *
52      * <p>Weight can be set to a {@link AnnotationRunPrecedence} constant, or to any {@link int}.
53      */
weight()54     int weight() default FIRST;
55 }
56