Record Class ModuleDependencyObservation

java.lang.Object

java.lang.Record

dev.archunitjava.rules.ModuleDependencyObservation

All Implemented Interfaces:

Comparable<ModuleDependencyObservation>

public record ModuleDependencyObservation(ModuleIdentityId origin, String targetModule, String evidenceDomain, Set<DependencyKind> dependencyKinds, List<DependencyEvidence> evidence)
extends Record
implements Comparable<ModuleDependencyObservation>

One detached declared or observed module dependency with its evidence domain kept explicit.

Constructor Summary

Constructors

Constructor	Description
ModuleDependencyObservation(ModuleIdentityId origin, String targetModule, String evidenceDomain, Set<DependencyKind> dependencyKinds, List<DependencyEvidence> evidence)	Creates an instance of a ModuleDependencyObservation record class.

Method Summary

Modifier and Type	Method	Description
int	compareTo(ModuleDependencyObservation other)
String	comparisonKey()
Set<DependencyKind>	dependencyKinds()	Returns the value of the dependencyKinds record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<DependencyEvidence>	evidence()	Returns the value of the evidence record component.
String	evidenceDomain()	Returns the value of the evidenceDomain record component.
final int	hashCode()	Returns a hash code value for this object.
ModuleIdentityId	origin()	Returns the value of the origin record component.
String	targetModule()	Returns the value of the targetModule 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

ModuleDependencyObservation

public ModuleDependencyObservation(ModuleIdentityId origin,
 String targetModule,
 String evidenceDomain,
 Set<DependencyKind> dependencyKinds,
 List<DependencyEvidence> evidence)

Creates an instance of a ModuleDependencyObservation record class.

Parameters:

origin - the value for the origin record component

targetModule - the value for the targetModule record component

evidenceDomain - the value for the evidenceDomain record component

dependencyKinds - the value for the dependencyKinds record component

evidence - the value for the evidence record component

Method Details

comparisonKey

public String comparisonKey()

compareTo

public int compareTo(ModuleDependencyObservation other)

Specified by:

compareTo in interface Comparable<ModuleDependencyObservation>

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.

origin

public ModuleIdentityId origin()

Returns the value of the origin record component.

Returns:

the value of the origin record component

targetModule

public String targetModule()

Returns the value of the targetModule record component.

Returns:

the value of the targetModule record component

evidenceDomain

public String evidenceDomain()

Returns the value of the evidenceDomain record component.

Returns:

the value of the evidenceDomain record component

dependencyKinds

public Set<DependencyKind> dependencyKinds()

Returns the value of the dependencyKinds record component.

Returns:

the value of the dependencyKinds record component

evidence

public List<DependencyEvidence> evidence()

Returns the value of the evidence record component.

Returns:

the value of the evidence record component