org.apache.samza.metrics

Class Gauge<T>

java.lang.Object

org.apache.samza.metrics.Gauge<T>

Type Parameters:

T - Instance to be wrapped in the gauge for metering.

All Implemented Interfaces:

Metric

Direct Known Subclasses:

BlockingEnvelopeMap.BufferGauge, BlockingEnvelopeMap.BufferSizeGauge

public class Gauge<T>
extends java.lang.Object
implements Metric

A Gauge is a Metric that wraps some instance of T in a thread-safe reference and allows it to be set or retrieved. Gauges record specific values over time. For example, the current length of a queue or the size of a buffer.

Constructor Summary

Constructors

Constructor and Description
Gauge(java.lang.String name, T value)

Method Summary

Modifier and Type	Method and Description
boolean	compareAndSet(T expected, T n)
java.lang.String	getName()
T	getValue()
T	set(T n)
java.lang.String	toString()
void	visit(MetricsVisitor visitor)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Gauge

public Gauge(java.lang.String name,
             T value)

Method Detail

compareAndSet

public boolean compareAndSet(T expected,
                             T n)

set

public T set(T n)

getValue

public T getValue()

getName

public java.lang.String getName()

visit

public void visit(MetricsVisitor visitor)

Specified by:

visit in interface Metric

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object