1 /*
2  * Copyright (C) 2011 Google Inc.
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.google.caliper.model;
18 
19 import java.lang.annotation.ElementType;
20 import java.lang.annotation.Retention;
21 import java.lang.annotation.RetentionPolicy;
22 import java.lang.annotation.Target;
23 
24 /**
25  * Annotation that identifies a given method as an "arbitrary measurement" method. The method should
26  * take no parameters and return a double, which is the measured value.
27  */
28 @Retention(RetentionPolicy.RUNTIME)
29 @Target(ElementType.METHOD)
30 public @interface ArbitraryMeasurement {
31 
32   /**
33    * The units for the value returned by this measurement method.
34    */
units()35   String units() default "";
36 
37   /**
38    * Text description of the quantity measured by this measurement method.
39    */
description()40   String description() default "";
41 }
42