org.springframework.xd.analytics.metrics.core

Class RichGauge

java.lang.Object

org.springframework.xd.analytics.metrics.core.RichGauge

All Implemented Interfaces:

Metric

public final class RichGauge
extends java.lang.Object
implements Metric

A gauge which stores the maximum, minimum and simple mean in addition to the current value.

Author:

Luke Taylor

Constructor Summary

Constructors

Constructor and Description
RichGauge(java.lang.String name) Creates an "empty" gauge.
RichGauge(java.lang.String name, double value)
RichGauge(java.lang.String name, double value, double mean, double max, double min, long count)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
long	getCount()
double	getMax()
double	getMean()
double	getMin()
java.lang.String	getName()
double	getValue()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RichGauge

public RichGauge(java.lang.String name)

Creates an "empty" gauge. The mean, max and min will be zero, but this initial value will not be included after the first value has been set on the gauge.

Parameters:

name - the name under which the gauge will be stored.

RichGauge

public RichGauge(java.lang.String name,
         double value)

RichGauge

public RichGauge(java.lang.String name,
         double value,
         double mean,
         double max,
         double min,
         long count)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface Metric

Returns:

the name of the gauge

getValue

public double getValue()

Returns:

the current value

getMean

public double getMean()

Returns:

The mean over all the accumulated values

getMax

public double getMax()

Returns:

the maximum value

getMin

public double getMin()

Returns:

the minimum value

getCount

public long getCount()

Returns:

Number of times the value has been set.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object