io.jenkins.plugins.metrics.model.metric

Class Metric<T extends Number>

java.lang.Object

io.jenkins.plugins.metrics.model.metric.Metric<T>

Type Parameters:

T - the data type for the metric

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DoubleMetric, IntegerMetric, PercentageMetric

public abstract class Metric<T extends Number>
extends Object
implements Serializable

This class represents a metric. It combines a MetricDefinition with a value for this metric.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected MetricDefinition	metricDefinition The definition for this metric.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Metric(MetricDefinition metricDefinition)

Method Summary

Modifier and Type	Method and Description
String	getId()
MetricDefinition	getMetricDefinition()
abstract T	rawValue() Return the raw value of this metric, e.g. used for calculations.
abstract String	renderValue() Return the value of this metric that should be displayed in the UI.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

metricDefinition

protected final MetricDefinition metricDefinition

The definition for this metric.

Constructor Detail

Metric

protected Metric(MetricDefinition metricDefinition)

Method Detail

renderValue

public abstract String renderValue()

Return the value of this metric that should be displayed in the UI.

Returns:

the string to display

rawValue

public abstract T rawValue()

Return the raw value of this metric, e.g. used for calculations.

Returns:

the raw value

getId

public String getId()

getMetricDefinition

public MetricDefinition getMetricDefinition()

toString

public String toString()

Overrides:

toString in class Object