Record Class SourceMetricReport

java.lang.Object

java.lang.Record

dev.archunitjava.metrics.SourceMetricReport

public record SourceMetricReport(SourceCounts aggregate, List<MetricSample> samples, List<TypeId> missingSourceTypes, List<TypeId> excludedGeneratedTypes)
extends Record

Aggregate counts plus threshold-ready subject samples and explicit omissions.

Constructor Summary

Constructors

Constructor	Description
SourceMetricReport(SourceCounts aggregate, List<MetricSample> samples, List<TypeId> missingSourceTypes, List<TypeId> excludedGeneratedTypes)	Creates an instance of a SourceMetricReport record class.

Method Summary

Modifier and Type	Method	Description
SourceCounts	aggregate()	Returns the value of the aggregate record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<TypeId>	excludedGeneratedTypes()	Returns the value of the excludedGeneratedTypes record component.
final int	hashCode()	Returns a hash code value for this object.
List<TypeId>	missingSourceTypes()	Returns the value of the missingSourceTypes record component.
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

SourceMetricReport

public SourceMetricReport(SourceCounts aggregate,
 List<MetricSample> samples,
 List<TypeId> missingSourceTypes,
 List<TypeId> excludedGeneratedTypes)

Creates an instance of a SourceMetricReport record class.

Parameters:

aggregate - the value for the aggregate record component

samples - the value for the samples record component

missingSourceTypes - the value for the missingSourceTypes record component

excludedGeneratedTypes - the value for the excludedGeneratedTypes record component

Method Details

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.

aggregate

public SourceCounts aggregate()

Returns the value of the aggregate record component.

Returns:

the value of the aggregate record component

samples

public List<MetricSample> samples()

Returns the value of the samples record component.

Returns:

the value of the samples record component

missingSourceTypes

public List<TypeId> missingSourceTypes()

Returns the value of the missingSourceTypes record component.

Returns:

the value of the missingSourceTypes record component

excludedGeneratedTypes

public List<TypeId> excludedGeneratedTypes()

Returns the value of the excludedGeneratedTypes record component.

Returns:

the value of the excludedGeneratedTypes record component