sirius.kernel.health.metrics

Class Metric

java.lang.Object

sirius.kernel.health.metrics.Metric

All Implemented Interfaces:

Comparable<Metric>

public class Metric
extends Object
implements Comparable<Metric>

Represents a measured value, recorded by the metrics framework.

Basically this combines a name along with a value and unit. Additionally an interpretation of the value is given as state.

Constructor Summary

Constructors

Constructor and Description
Metric(String name, double value, MetricState state, String unit) Creates a new metric using the given values

Method Summary

Modifier and Type	Method and Description
int	compareTo(Metric o)
boolean	equals(Object o)
String	getName() Returns the name of the metric.
MetricState	getState() Returns an interpretation of the value (@see MetricState).
String	getUnit() The unit in which the value is measured
double	getValue() Returns the actual value of the metric.
String	getValueAsString() String representation of the value along with its unit (is necessary)
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

Metric

public Metric(String name,
              double value,
              MetricState state,
              String unit)

Creates a new metric using the given values

Parameters:

name - the name of the metric

value - the actual value

state - the interpretation of the value

unit - the unit in which the value is measured or null if there is no unit

Method Detail

getName

public String getName()

Returns the name of the metric.

Returns:

the name of the metric

getValue

public double getValue()

Returns the actual value of the metric.

Returns:

the measured value of the metric

getUnit

public String getUnit()

The unit in which the value is measured

Returns:

the unit of the value or null if there is no unit

getValueAsString

public String getValueAsString()

String representation of the value along with its unit (is necessary)

Returns:

a string representation of the value

getState

public MetricState getState()

Returns an interpretation of the value (@see MetricState).

Returns:

an interpretation of the value

compareTo

public int compareTo(Metric o)

Specified by:

compareTo in interface Comparable<Metric>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object