RatioGauge (Metrics Parent 4.1.0 API)

java.lang.Object
- com.codahale.metrics.RatioGauge

All Implemented Interfaces:

Gauge<Double>, Metric

Direct Known Subclasses:

FileDescriptorRatioGauge
```
public abstract class RatioGauge
extends Object
implements Gauge<Double>
```
A gauge which measures the ratio of one value to another.
If the denominator is zero, not a number, or infinite, the resulting ratio is not a number.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class RatioGauge.Ratio
A ratio of one quantity to another.

Constructor Summary

Constructors
Constructor Description

RatioGauge()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract RatioGauge.Ratio`	`getRatio()`	Returns the `RatioGauge.Ratio` which is the gauge's current value.
`Double`	`getValue()`	Returns the metric's current value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RatioGauge
```
public RatioGauge()
```
- Method Detail
  - getRatio
```
protected abstract RatioGauge.Ratio getRatio()
```
    Returns the RatioGauge.Ratio which is the gauge's current value.
    
    Returns:
    
    the RatioGauge.Ratio which is the gauge's current value
  - getValue
```
public Double getValue()
```
    Description copied from interface: Gauge
    
    Returns the metric's current value.
    
    Specified by:
    
    getValue in interface Gauge<Double>
    
    Returns:
    
    the metric's current value