Package com.inductiveautomation.ignition.gateway.metrics

Class DescriptiveDelegateCounter

java.lang.Object

com.codahale.metrics.Counter

com.inductiveautomation.ignition.gateway.metrics.DescriptiveDelegateCounter

All Implemented Interfaces:

com.codahale.metrics.Counting, com.codahale.metrics.Metric, DescriptiveMetric

public class DescriptiveDelegateCounter
extends com.codahale.metrics.Counter
implements DescriptiveMetric

A counter implementation that delegates to another Counter instance, while adding descriptive attributes.

Constructor Summary

Constructors

Constructor	Description
DescriptiveDelegateCounter(com.codahale.metrics.Counter delegate, Function<Locale,String> description, Function<Locale,String> units)

Method Summary

Modifier and Type	Method	Description
void	dec()
void	dec(long n)
long	getCount()
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.
void	inc()
void	inc(long n)

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

DescriptiveDelegateCounter

public DescriptiveDelegateCounter(com.codahale.metrics.Counter delegate,
 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

inc

public void inc()

Overrides:

inc in class com.codahale.metrics.Counter

inc

public void inc(long n)

Overrides:

inc in class com.codahale.metrics.Counter

dec

public void dec()

Overrides:

dec in class com.codahale.metrics.Counter

dec

public void dec(long n)

Overrides:

dec in class com.codahale.metrics.Counter

getCount

public long getCount()

Specified by:

getCount in interface com.codahale.metrics.Counting

Overrides:

getCount in class com.codahale.metrics.Counter