org.qi4j.api.metrics
Interface MetricsGaugeFactory

All Superinterfaces:

MetricsFactory

All Known Implementing Classes:

NullMetricsFactory.NullGaugeFactory

public interface MetricsGaugeFactory
extends MetricsFactory

Register MetricsGauge with the underlying Metrics system.

Method Summary

<T> MetricsGauge<T>

registerGauge(java.lang.Class<?> origin, java.lang.String name, MetricsGauge<T> gauge) Register a MetricsGauge with the underlying Metrics system.

Methods inherited from interface org.qi4j.api.metrics.MetricsFactory

registered

Method Detail

registerGauge

<T> MetricsGauge<T> registerGauge(java.lang.Class<?> origin,
                                  java.lang.String name,
                                  MetricsGauge<T> gauge)

Register a MetricsGauge with the underlying Metrics system.

Type Parameters:

T - Any type holding the MetricsGauge's current value.

Parameters:

origin - The class where the MetricsGauge is created.

name - A human readable, short name of the metric.

gauge - The implementation of the MetricsGauge.

Returns:

The same MetricsGauge or the DefaultMetric.NULL MetricsGauge instance.