Record Class MetricSample

java.lang.Object
java.lang.Record
dev.archunitjava.metrics.MetricSample
All Implemented Interfaces:
Comparable<MetricSample>
public record MetricSample(StableId subject, MetricName metric, MetricAmount amount) extends Record implements Comparable<MetricSample>
One deterministic metric observation for one typed architecture subject.

  • Constructor Details

    • MetricSample

      public MetricSample(StableId subject, MetricName metric, MetricAmount amount)
      Creates an instance of a MetricSample record class.
      Parameters:
      subject - the value for the subject record component
      metric - the value for the metric record component
      amount - the value for the amount record component

  • Method Details

    • compareTo

      public int compareTo(MetricSample other)
      Specified by:
      compareTo in interface Comparable<MetricSample>

    • 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.

    • subject

      public StableId subject()
      Returns the value of the subject record component.
      Returns:
      the value of the subject record component

    • metric

      public MetricName metric()
      Returns the value of the metric record component.
      Returns:
      the value of the metric record component

    • amount

      public MetricAmount amount()
      Returns the value of the amount record component.
      Returns:
      the value of the amount record component