com.codahale.metrics.annotation

Annotation Type ResponseMetered

@Inherited
 @Documented
 @Retention(value=RUNTIME)
 @Target(value={TYPE,CONSTRUCTOR,METHOD,ANNOTATION_TYPE})
public @interface ResponseMetered

An annotation for marking a method of an annotated object as metered.

Given a method like this:

      @ResponseMetered(name = "fancyName")
     public String fancyName(String name) {
         return "Sir Captain " + name;
     }
 

A meter for the defining class with the name fancyName will be created for 1xx/2xx/3xx/4xx/5xx responses and each time the #fancyName(String) method is invoked, the appropriate response meter will be marked.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	absolute
String	name

Element Detail

name

public abstract String name

Returns:

The name of the meter.

Default:

""

absolute

public abstract boolean absolute

Returns:

If true, use the given name as an absolute name. If false, use the given name relative to the annotated class. When annotating a class, this must be false.

Default:

false