Record Class MetricThreshold

java.lang.Object

java.lang.Record

dev.archunitjava.metrics.MetricThreshold

public record MetricThreshold(MetricName metric, MetricComparison comparison, MetricAmount limit)
extends Record

Typed inclusive threshold; construction rejects a limit expressed in the wrong unit.

Constructor Summary

Constructors

Constructor	Description
MetricThreshold(MetricName metric, MetricComparison comparison, MetricAmount limit)	Creates an instance of a MetricThreshold record class.

Method Summary

Modifier and Type	Method	Description
static MetricThreshold	atLeast(MetricName metric, MetricAmount limit)
static MetricThreshold	atMost(MetricName metric, MetricAmount limit)
MetricComparison	comparison()	Returns the value of the comparison record component.
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.
MetricAmount	limit()	Returns the value of the limit record component.
MetricName	metric()	Returns the value of the metric record component.
final String	toString()	Returns a string representation of this record class.
boolean	violatedBy(MetricSample sample)

Methods inherited from class Object

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

Constructor Details

MetricThreshold

public MetricThreshold(MetricName metric,
 MetricComparison comparison,
 MetricAmount limit)

Creates an instance of a MetricThreshold record class.

Parameters:

metric - the value for the metric record component

comparison - the value for the comparison record component

limit - the value for the limit record component

Method Details

atMost

public static MetricThreshold atMost(MetricName metric,
 MetricAmount limit)

atLeast

public static MetricThreshold atLeast(MetricName metric,
 MetricAmount limit)

violatedBy

public boolean violatedBy(MetricSample sample)

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.

metric

public MetricName metric()

Returns the value of the metric record component.

Returns:

the value of the metric record component

comparison

public MetricComparison comparison()

Returns the value of the comparison record component.

Returns:

the value of the comparison record component

limit

public MetricAmount limit()

Returns the value of the limit record component.

Returns:

the value of the limit record component