Record Class ComponentDependencyMetrics

java.lang.Object
java.lang.Record
dev.archunitjava.metrics.ComponentDependencyMetrics
All Implemented Interfaces:
Comparable<ComponentDependencyMetrics>
public record ComponentDependencyMetrics(StableId component, int afferentCoupling, int efferentCoupling, double instability, double abstractness, double distanceFromMainSequence) extends Record implements Comparable<ComponentDependencyMetrics>
Robert C. Martin metrics. Couplings count distinct other components, instability is Ce/(Ca+Ce) with 0 for no coupling, abstractness is abstract/total with 0 for no types, and distance is |A+I-1|.

  • Constructor Details

    • ComponentDependencyMetrics

      public ComponentDependencyMetrics(StableId component, int afferentCoupling, int efferentCoupling, double instability, double abstractness, double distanceFromMainSequence)
      Creates an instance of a ComponentDependencyMetrics record class.
      Parameters:
      component - the value for the component record component
      afferentCoupling - the value for the afferentCoupling record component
      efferentCoupling - the value for the efferentCoupling record component
      instability - the value for the instability record component
      abstractness - the value for the abstractness record component
      distanceFromMainSequence - the value for the distanceFromMainSequence record component

  • Method Details

    • samples

      public List<MetricSample> samples()

    • compareTo

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

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • component

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

    • afferentCoupling

      public int afferentCoupling()
      Returns the value of the afferentCoupling record component.
      Returns:
      the value of the afferentCoupling record component

    • efferentCoupling

      public int efferentCoupling()
      Returns the value of the efferentCoupling record component.
      Returns:
      the value of the efferentCoupling record component

    • instability

      public double instability()
      Returns the value of the instability record component.
      Returns:
      the value of the instability record component

    • abstractness

      public double abstractness()
      Returns the value of the abstractness record component.
      Returns:
      the value of the abstractness record component

    • distanceFromMainSequence

      public double distanceFromMainSequence()
      Returns the value of the distanceFromMainSequence record component.
      Returns:
      the value of the distanceFromMainSequence record component