com.codahale.metrics

Class RatioGauge.Ratio

java.lang.Object

com.codahale.metrics.RatioGauge.Ratio

Enclosing class:

RatioGauge

public static class RatioGauge.Ratio
extends java.lang.Object

A ratio of one quantity to another.

Method Summary

Modifier and Type	Method and Description
double	getValue() Returns the ratio, which is either a double between 0 and 1 (inclusive) or NaN.
static RatioGauge.Ratio	of(double numerator, double denominator) Creates a new ratio with the given numerator and denominator.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

of

public static RatioGauge.Ratio of(double numerator,
                                  double denominator)

Creates a new ratio with the given numerator and denominator.

Parameters:

numerator - the numerator of the ratio

denominator - the denominator of the ratio

Returns:

numerator:denominator

getValue

public double getValue()

Returns the ratio, which is either a double between 0 and 1 (inclusive) or NaN.

Returns:

the ratio

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object