1 /*
2  * Copyright (C) 2018 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 package com.android.tradefed.device.metric;
17 
18 import com.android.tradefed.result.TestDescription;
19 
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  * Annotation for test methods annotated with {@code @Test}, or if the annotation is part of the
27  * annotation list of {@link TestDescription} that allows to specify some extra parameters useful
28  * for: Tuning the behavior of the collectors, filtering some methods.
29  */
30 @Retention(RetentionPolicy.RUNTIME)
31 @Target(ElementType.METHOD)
32 public @interface MetricOption {
33 
34     /**
35      * Defines a group name, all method annotated with the same name will be considered part of the
36      * same group. By default or when the annotation is not specified method will be considered part
37      * of a default group. Can be comma separated to be part of several groups.
38      */
group()39     String group() default "";
40 }
41