com.onloupe.agent.metrics.annotation.EventMetricValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core Show documentation

Core functionality of Loupe.

There is a newer version: 1.0.2

package com.onloupe.agent.metrics.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import com.onloupe.agent.metrics.SummaryFunction;


/**
 * The Interface EventMetricValue.
 */
@Repeatable(EventMetricValues.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD})
public @interface EventMetricValue {
	
	/**
	 * Name.
	 *
	 * @return the string
	 */
	String name();
	
	/**
	 * Unit caption.
	 *
	 * @return the string
	 */
	String unitCaption() default "";
	
	/**
	 * Summary function.
	 *
	 * @return the summary function
	 */
	SummaryFunction summaryFunction();
	
	/**
	 * Caption.
	 *
	 * @return the string
	 */
	String caption();
	
	/**
	 * Description.
	 *
	 * @return the string
	 */
	String description();
	
	/**
	 * Default value.
	 *
	 * @return true, if successful
	 */
	boolean defaultValue() default false;
}