Record Class MetricAmount

java.lang.Object

java.lang.Record

dev.archunitjava.metrics.MetricAmount

All Implemented Interfaces:

Comparable<MetricAmount>

public record MetricAmount(BigDecimal value, MetricUnit unit)
extends Record
implements Comparable<MetricAmount>

Exact decimal metric amount paired with its non-interchangeable unit.

Constructor Summary

Constructors

Constructor	Description
MetricAmount(BigDecimal value, MetricUnit unit)	Creates an instance of a MetricAmount record class.

Method Summary

Modifier and Type	Method	Description
int	compareTo(MetricAmount other)
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.
static MetricAmount	of(double value, MetricUnit unit)
static MetricAmount	of(long value, MetricUnit unit)
String	stableValue()
final String	toString()	Returns a string representation of this record class.
MetricUnit	unit()	Returns the value of the unit record component.
BigDecimal	value()	Returns the value of the value record component.

Methods inherited from class Object

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

Constructor Details

MetricAmount

public MetricAmount(BigDecimal value,
 MetricUnit unit)

Creates an instance of a MetricAmount record class.

Parameters:

value - the value for the value record component

unit - the value for the unit record component

Method Details

of

public static MetricAmount of(long value,
 MetricUnit unit)

of

public static MetricAmount of(double value,
 MetricUnit unit)

stableValue

public String stableValue()

compareTo

public int compareTo(MetricAmount other)

Specified by:

compareTo in interface Comparable<MetricAmount>

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.

value

public BigDecimal value()

Returns the value of the value record component.

Returns:

the value of the value record component

unit

public MetricUnit unit()

Returns the value of the unit record component.

Returns:

the value of the unit record component