org.kuali.rice.web.health

Class HealthMetric

java.lang.Object

org.kuali.rice.web.health.HealthMetric

public class HealthMetric
extends Object

Defines the name and value for a single metric. All metrics must have a "Measure" name, a "Metric" name and a value. The value may be any value that translates property to JSON. The value may also be null. This class is annotated such that it should serialize to JSON when using the Jackson library.

Author:

Eric Westfall

Constructor Summary

Constructors

Constructor and Description
HealthMetric(String name, Object value) Construct a new HealthMetric using the given two-art name and value.
HealthMetric(String measure, String metric, Object value) Construct a new HealthMetric with the given measure name, metric name, and value.

Method Summary

Modifier and Type	Method and Description
String	getMeasure()
String	getMetric()
Object	getValue()

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthMetric

public HealthMetric(String name,
                    Object value)

Construct a new HealthMetric using the given two-art name and value. The format of the name is "Measure:Metric" where "Measure" and "Metric" are replaced by the desired measure and metric name. Invoking new HealthMetric("a:b", "c") is equivalent to invoking new HealthMetric("a", "b", "c")

Parameters:

name - the name for this health metric, must be a string that includes two non-blank parts separated by a colon

value - the value of this health metric

HealthMetric

public HealthMetric(String measure,
                    String metric,
                    Object value)

Construct a new HealthMetric with the given measure name, metric name, and value.

Parameters:

measure - the name of the measure

metric - the name of the metric

value - the value of this health metric

Method Detail

getMeasure

public String getMeasure()

getMetric

public String getMetric()

getValue

public Object getValue()