Class DropwizardTypes.DescribableGauge<T>
- java.lang.Object
-
- org.forgerock.monitoring.dropwizard.DropwizardTypes.DescribableGauge<T>
-
- Type Parameters:
T
- The type of the object being passed in
- All Implemented Interfaces:
com.codahale.metrics.Gauge<Double>
,com.codahale.metrics.Metric
,Gauge
,Meter
,DropwizardTypes.DescribableMetric
- Enclosing class:
- DropwizardTypes
public static final class DropwizardTypes.DescribableGauge<T> extends Object implements com.codahale.metrics.Gauge<Double>, DropwizardTypes.DescribableMetric, Gauge
A describable gauge, implementing both the dropwizard's and the monitoring-api's relevant APIs.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.forgerock.monitoring.api.instrument.Gauge
Gauge.Builder<T>
-
Nested classes/interfaces inherited from interface org.forgerock.monitoring.api.instrument.Meter
Meter.Id, Meter.Type
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Meter.Id
getId()
Returns A unique combination of name and tags identifying this metric.Double
getValue()
String
toString()
double
value()
Returns the current value.
-
-
-
Method Detail
-
getId
public Meter.Id getId()
Description copied from interface:DropwizardTypes.DescribableMetric
Returns A unique combination of name and tags identifying this metric.- Specified by:
getId
in interfaceDropwizardTypes.DescribableMetric
- Specified by:
getId
in interfaceMeter
- Returns:
- A unique combination of name and tags identifying this metric
-
value
public double value()
Description copied from interface:Gauge
Returns the current value. The act of observing the value by calling this method triggers sampling of the underlying number or user-defined function that defines the value for the gauge.
-
-