Record Class DependencyMetricReport

java.lang.Object

java.lang.Record

dev.archunitjava.metrics.DependencyMetricReport

public record DependencyMetricReport(ProjectionDomain domain, List<ComponentDependencyMetrics> components, CumulativeDependencyMetrics cumulative, List<MetricSample> samples)
extends Record

Projection-scoped component and cumulative metrics with threshold-ready samples.

Constructor Summary

Constructors

Constructor	Description
DependencyMetricReport(ProjectionDomain domain, List<ComponentDependencyMetrics> components, CumulativeDependencyMetrics cumulative, List<MetricSample> samples)	Creates an instance of a DependencyMetricReport record class.

Method Summary

Modifier and Type	Method	Description
List<ComponentDependencyMetrics>	components()	Returns the value of the components record component.
CumulativeDependencyMetrics	cumulative()	Returns the value of the cumulative record component.
ProjectionDomain	domain()	Returns the value of the domain 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.
static DependencyMetricReport	of(ProjectionDomain domain, List<ComponentDependencyMetrics> components, CumulativeDependencyMetrics cumulative)
List<MetricSample>	samples()	Returns the value of the samples record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

DependencyMetricReport

public DependencyMetricReport(ProjectionDomain domain,
 List<ComponentDependencyMetrics> components,
 CumulativeDependencyMetrics cumulative,
 List<MetricSample> samples)

Creates an instance of a DependencyMetricReport record class.

Parameters:

domain - the value for the domain record component

components - the value for the components record component

cumulative - the value for the cumulative record component

samples - the value for the samples record component

Method Details

of

public static DependencyMetricReport of(ProjectionDomain domain,
 List<ComponentDependencyMetrics> components,
 CumulativeDependencyMetrics cumulative)

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.

domain

public ProjectionDomain domain()

Returns the value of the domain record component.

Returns:

the value of the domain record component

components

public List<ComponentDependencyMetrics> components()

Returns the value of the components record component.

Returns:

the value of the components record component

cumulative

public CumulativeDependencyMetrics cumulative()

Returns the value of the cumulative record component.

Returns:

the value of the cumulative record component

samples

public List<MetricSample> samples()

Returns the value of the samples record component.

Returns:

the value of the samples record component