Package eu.rarogsoftware.rarog.platform.api.metrics

Record Class MetricSamples

java.lang.Object

java.lang.Record

eu.rarogsoftware.rarog.platform.api.metrics.MetricSamples

Record Components:

settings - settings of metric

type - type of metric. It is used by some exposer and exporters

samples - samples extracted from metric

public record MetricSamples(MetricSettings settings, MetricSamples.Type type, Collection<Sample> samples)
extends Record

Object representing samples from specific metric.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MetricSamples.Type	Type of metric.

Constructor Summary

Constructors

Constructor	Description
MetricSamples(MetricSettings settings, MetricSamples.Type type, Collection<Sample> samples)	Creates an instance of a MetricSamples record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Collection<Sample>	samples()	Returns the value of the samples record component.
MetricSettings	settings()	Returns the value of the settings record component.
final String	toString()	Returns a string representation of this record class.
MetricSamples.Type	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

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

Constructor Details

MetricSamples

public MetricSamples(MetricSettings settings,
 MetricSamples.Type type,
 Collection<Sample> samples)

Creates an instance of a MetricSamples record class.

Parameters:

settings - the value for the settings record component

type - the value for the type record component

samples - the value for the samples record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

settings

public MetricSettings settings()

Returns the value of the settings record component.

Returns:

the value of the settings record component

type

public MetricSamples.Type type()

Returns the value of the type record component.

Returns:

the value of the type record component

samples

public Collection<Sample> samples()

Returns the value of the samples record component.

Returns:

the value of the samples record component