Package com.inductiveautomation.ignition.gateway.metrics

Class DescriptiveGauge<T>

java.lang.Object

com.inductiveautomation.ignition.gateway.metrics.DescriptiveGauge<T>

All Implemented Interfaces:

com.codahale.metrics.Gauge<T>, com.codahale.metrics.Metric, DescriptiveMetric

public class DescriptiveGauge<T>
extends Object
implements com.codahale.metrics.Gauge<T>, DescriptiveMetric

Constructor Summary

Constructors

Constructor	Description
DescriptiveGauge(com.codahale.metrics.Gauge<T> gauge, Function<Locale,String> description, Function<Locale,String> units)

Method Summary

Modifier and Type	Method	Description
String	getDescription(Locale locale)	A short description of what this metric represents.
String	getUnits(Locale locale)	A short string representing the units of this metric.
T	getValue()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.gateway.metrics.DescriptiveMetric

getDescription, getUnits

Constructor Details

DescriptiveGauge

public DescriptiveGauge(com.codahale.metrics.Gauge<T> gauge,
 Function<Locale,String> description,
 Function<Locale,String> units)

Method Details

getDescription

public String getDescription(Locale locale)

Description copied from interface: DescriptiveMetric

A short description of what this metric represents. For example "JVM Heap Size" or "Thread Count" or "Subsystem X script executions"

Specified by:

getDescription in interface DescriptiveMetric

getUnits

public String getUnits(Locale locale)

Description copied from interface: DescriptiveMetric

A short string representing the units of this metric. For example "MB" or "threads" or "executions"

Specified by:

getUnits in interface DescriptiveMetric

getValue

public T getValue()

Specified by:

getValue in interface com.codahale.metrics.Gauge<T>