• 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.meta;
18 
19 import java.lang.annotation.Annotation;
20 import java.lang.annotation.ElementType;
21 import java.lang.annotation.Retention;
22 import java.lang.annotation.RetentionPolicy;
23 import java.lang.annotation.Target;
24 
25 /**
26  * Mark a Harrier annotation as being Parameterized.
27  *
28  * <p>There will be a separate run generated for the annotated method for each
29  * {@link ParameterizedAnnotation} annotation. The test will be named methodName[paramName].
30  *
31  * <p>If any {@link ParameterizedAnnotation} annotations are applied to a test, then the basic
32  * un-parameterized test will not be run.
33  */
34 @Target(ElementType.ANNOTATION_TYPE)
35 @Retention(RetentionPolicy.RUNTIME)
36 @RequiresBedsteadJUnit4
37 public @interface ParameterizedAnnotation {
38 
39     /**
40      * Other parameterized annotations which are less powerful versions of this one.
41      *
42      * <p>For example, if this annotation represents a permission, and there is another annotation
43      * representing a permission which allows a subset of this one, then this annotation may shadow
44      * that one.
45      *
46      * <p>This will mean that these annotations will never be used together - one will be removed
47      * depending on whether the test requires the most powerful or least powerful state.
48      *
49      * <p>This should not be used if you want to explicitly test the state represented by each
50      * annotation.
51      */
shadows()52     Class<? extends Annotation>[] shadows() default {};
53 }
54