org.springframework.boot.actuate.metrics

Class Metric<T extends Number>

java.lang.Object

org.springframework.boot.actuate.metrics.Metric<T>

Type Parameters:

T - the value type

Direct Known Subclasses:

Delta

public class Metric<T extends Number>
extends Object

Immutable class that can be used to hold any arbitrary system measurement value (a named numeric value with a timestamp). For example a metric might record the number of active connections to a server, or the temperature of a meeting room.

Author:

Dave Syer

Constructor Summary

Constructors

Constructor and Description
Metric(String name, T value) Create a new Metric instance for the current time.
Metric(String name, T value, Date timestamp) Create a new Metric instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getName() Returns the name of the metric.
Date	getTimestamp()
T	getValue() Returns the value of the metric.
int	hashCode()
Metric<Long>	increment(int amount) Create a new Metric with an incremented value.
<S extends Number> Metric<S>	set(S value) Create a new Metric with a different value.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Metric

public Metric(String name,
      T value)

Create a new Metric instance for the current time.

Parameters:

name - the name of the metric

value - the value of the metric

Metric

public Metric(String name,
      T value,
      Date timestamp)

Create a new Metric instance.

Parameters:

name - the name of the metric

value - the value of the metric

timestamp - the timestamp for the metric

Method Detail

getName

public String getName()

Returns the name of the metric.

Returns:

the name

getValue

public T getValue()

Returns the value of the metric.

Returns:

the value

getTimestamp

public Date getTimestamp()

toString

public String toString()

Overrides:

toString in class Object

increment

public Metric<Long> increment(int amount)

Create a new Metric with an incremented value.

Parameters:

amount - the amount that the new metric will differ from this one

Returns:

a new Metric instance

set

public <S extends Number> Metric<S> set(S value)

Create a new Metric with a different value.

Type Parameters:

S - the metric value type

Parameters:

value - the value of the new metric

Returns:

a new Metric instance

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object