org.springframework.boot.actuate.metrics

Class Metric

java.lang.Object

org.springframework.boot.actuate.metrics.Metric

public final class Metric
extends Object

Immutable class that can be used to hold any arbitrary system measurement value. For example a metric might record the number of active connections.

Author:

Dave Syer

See Also:

MetricRepository, CounterService

Constructor Summary

Constructors

Constructor and Description
Metric(String name, double value) 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.
double	getValue() Returns the value of the metric.
int	hashCode()
Metric	increment(int amount) Create a new Metric with an incremented value.
Metric	set(double 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,
      double value)

Create a new Metric instance.

Parameters:

name - the name of the metric

value - the value of the metric

Method Detail

getName

public String getName()

Returns the name of the metric.

getValue

public double getValue()

Returns the value of the metric.

increment

public Metric 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 Metric set(double value)

Create a new Metric with a different value.

Parameters:

value - the value of the new metric

Returns:

a new Metric instance

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object