Gauge.java

package com.codahale.metrics;

/**
 * A gauge metric is an instantaneous reading of a particular value. To
 * instrument a queue's depth, for example:<br>
 * 
 * <pre>
 * <code>
 * final Queue<String> queue = new ConcurrentLinkedQueue<String>();
 * final Gauge<Integer> queueDepth = new Gauge<Integer>() {
 *     public Integer getValue() {
 *         return queue.size();
 *     }
 * };
 * </code>
 * </pre>
 *
 * @param <T>
 *            the type of the metric's value
 */
public interface Gauge<T> extends Metric {
    /**
     * Returns the metric's current value.
     *
     * @return the metric's current value
     */
    T getValue();
}