Package com.tngtech.archunit.library.modules

Class ModuleDependency<DESCRIPTOR extends ArchModule.Descriptor>

java.lang.Object

com.tngtech.archunit.library.modules.ModuleDependency<DESCRIPTOR>

All Implemented Interfaces:

HasDescription

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public final class ModuleDependency<DESCRIPTOR extends ArchModule.Descriptor>
extends Object
implements HasDescription

A dependency between two ArchModules. I.e. origin and target are of type ArchModule and the dependency reflects the group of all class dependencies where the origin class resides in the origin module and the target class resides in the target module.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getDescription()
ArchModule<DESCRIPTOR>	getOrigin()
ArchModule<DESCRIPTOR>	getTarget()
int	hashCode()
Set<Dependency>	toClassDependencies()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getOrigin

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public ArchModule<DESCRIPTOR> getOrigin()

Returns:

The module where this dependency originates from

getTarget

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public ArchModule<DESCRIPTOR> getTarget()

Returns:

The module that this dependency targets

toClassDependencies

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public Set<Dependency> toClassDependencies()

Returns:

All the single class dependencies that form this ModuleDependency, i.e. all dependencies where the origin class resides in the origin module and the target class resides in the target module.

getDescription

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public String getDescription()

Specified by:

getDescription in interface HasDescription

Returns:

A textual representation of this ModuleDependency that can be used for textual reports.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object