io.dropwizard.metrics5.annotation.Counted Maven / Gradle / Ivy
package io.dropwizard.metrics5.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* An annotation for marking a method of an annotated object as counted.
*
*
* Given a method like this:
*
* {@literal @}Counted(name = "fancyName")
* public String fancyName(String name) {
* return "Sir Captain " + name;
* }
*
*
* A counter for the defining class with the name {@code fancyName} will be created and each time the
* {@code #fancyName(String)} method is invoked, the counter will be marked.
*
* @since 3.1
*/
@Inherited
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.ANNOTATION_TYPE })
public @interface Counted {
/**
* @return The name of the counter.
*/
String name() default "";
/**
* @return If {@code true}, use the given name as an absolute name. If {@code false}, use the given name
* relative to the annotated class. When annotating a class, this must be {@code false}.
*/
boolean absolute() default false;
/**
* @return
* If {@code false} (default), the counter is decremented when the annotated
* method returns, counting current invocations of the annotated method.
* If {@code true}, the counter increases monotonically, counting total
* invocations of the annotated method.
*/
boolean monotonic() default false;
}