Record Class SourceMetricOptions

java.lang.Object

java.lang.Record

dev.archunitjava.metrics.SourceMetricOptions

public record SourceMetricOptions(boolean includeSyntheticMembers, boolean includeGeneratedTypes, boolean includePackageInfoTypes, Set<String> generatedAnnotationBinaryNames)
extends Record

Explicit source-count policy. Defaults exclude synthetic/bridge members, conservative generated types/documents, and package-info metadata types. Record components are counted separately; actual record fields/accessors in the class file remain ordinary members unless synthetic.

Constructor Summary

Constructors

Constructor	Description
SourceMetricOptions(boolean includeSyntheticMembers, boolean includeGeneratedTypes, boolean includePackageInfoTypes, Set<String> generatedAnnotationBinaryNames)	Creates an instance of a SourceMetricOptions record class.

Method Summary

Modifier and Type	Method	Description
static SourceMetricOptions	defaults()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Set<String>	generatedAnnotationBinaryNames()	Returns the value of the generatedAnnotationBinaryNames record component.
final int	hashCode()	Returns a hash code value for this object.
boolean	includeGeneratedTypes()	Returns the value of the includeGeneratedTypes record component.
boolean	includePackageInfoTypes()	Returns the value of the includePackageInfoTypes record component.
boolean	includeSyntheticMembers()	Returns the value of the includeSyntheticMembers 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

SourceMetricOptions

public SourceMetricOptions(boolean includeSyntheticMembers,
 boolean includeGeneratedTypes,
 boolean includePackageInfoTypes,
 Set<String> generatedAnnotationBinaryNames)

Creates an instance of a SourceMetricOptions record class.

Parameters:

includeSyntheticMembers - the value for the includeSyntheticMembers record component

includeGeneratedTypes - the value for the includeGeneratedTypes record component

includePackageInfoTypes - the value for the includePackageInfoTypes record component

generatedAnnotationBinaryNames - the value for the generatedAnnotationBinaryNames record component

Method Details

defaults

public static SourceMetricOptions defaults()

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.

includeSyntheticMembers

public boolean includeSyntheticMembers()

Returns the value of the includeSyntheticMembers record component.

Returns:

the value of the includeSyntheticMembers record component

includeGeneratedTypes

public boolean includeGeneratedTypes()

Returns the value of the includeGeneratedTypes record component.

Returns:

the value of the includeGeneratedTypes record component

includePackageInfoTypes

public boolean includePackageInfoTypes()

Returns the value of the includePackageInfoTypes record component.

Returns:

the value of the includePackageInfoTypes record component

generatedAnnotationBinaryNames

public Set<String> generatedAnnotationBinaryNames()

Returns the value of the generatedAnnotationBinaryNames record component.

Returns:

the value of the generatedAnnotationBinaryNames record component