/*
***************************************************************************************
* Copyright (C) 2006 EsperTech, Inc. All rights reserved. *
* http://www.espertech.com/esper *
* http://www.espertech.com *
* ---------------------------------------------------------------------------------- *
* The software in this package is published under the terms of the GPL license *
* a copy of which has been included with this distribution in the license.txt file. *
***************************************************************************************
*/
/*
***************************************************************************************
* Copyright (C) 2006 EsperTech, Inc. All rights reserved. *
* http://www.espertech.com/esper *
* http://www.espertech.com *
* ---------------------------------------------------------------------------------- *
* The software in this package is published under the terms of the GPL license *
* a copy of which has been included with this distribution in the license.txt file. *
***************************************************************************************
*/
/***************************************************************************************
* Attribution Notice
*
* This file is imported from Metrics (https://github.com/codahale/metrics subproject metrics-core).
* Metrics is Copyright (c) 2010-2012 Coda Hale, Yammer.com
* Metrics is Published under Apache Software License 2.0, see LICENSE in root folder.
*
* Thank you for the Metrics developers efforts in making their library available under an Apache license.
* EsperTech incorporates Metrics version 0.2.2 in source code form since Metrics depends on SLF4J
* and this dependency is not possible to introduce for Esper.
* *************************************************************************************
*/
package com.espertech.esper.metrics.codahale_metrics.metrics.core;
/**
* 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 value() {
* return queue.size();
* }
* };
* </code></pre>
*
* @param <T> the type of the metric's value
*/
public abstract class Gauge<T> implements Metric {
/**
* Returns the metric's current value.
*
* @return the metric's current value
*/
public abstract T value();
@Override
public <U> void processWith(MetricProcessor<U> processor, MetricName name, U context) throws Exception {
processor.processGauge(name, this, context);
}
}